From 5ab85b076bcab9f64903b74facce9466259fed15 Mon Sep 17 00:00:00 2001 From: marijus Date: Mon, 15 Sep 2014 10:39:38 +0200 Subject: [PATCH 01/32] heading font-size should not be tied to font-size for posts and comments --- view/theme/redbasic/css/style.css | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/view/theme/redbasic/css/style.css b/view/theme/redbasic/css/style.css index bb11ddbb9..7c203d475 100644 --- a/view/theme/redbasic/css/style.css +++ b/view/theme/redbasic/css/style.css @@ -2260,11 +2260,11 @@ h1, h2 { } h3, h4 { - font-size: $font_size; + font-size: 1rem; } h5, h6 { - font-size: $body_font_size; + font-size: 0.75rem; } .dropdown-menu { From 5188e1999721ba63fb7e88782af08d0b0e780dc9 Mon Sep 17 00:00:00 2001 From: friendica Date: Mon, 15 Sep 2014 01:40:22 -0700 Subject: [PATCH 02/32] rev update --- version.inc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/version.inc b/version.inc index 82ede1be5..c3d994d3e 100644 --- a/version.inc +++ b/version.inc @@ -1 +1 @@ -2014-09-14.798 +2014-09-15.799 From eaf3bd3326a657662321df791280b41293f54ef2 Mon Sep 17 00:00:00 2001 From: Jeroen Date: Mon, 15 Sep 2014 15:35:40 +0000 Subject: [PATCH 03/32] See comments on commit 5ab85b0. Also fixed some bb typo's in docu index. --- doc/main.bb | 4 ++-- view/theme/redbasic/css/style.css | 24 ++++++++++++++++++------ 2 files changed, 20 insertions(+), 8 deletions(-) diff --git a/doc/main.bb b/doc/main.bb index e0cca3d31..9baeeebda 100644 --- a/doc/main.bb +++ b/doc/main.bb @@ -49,8 +49,8 @@ Zot is the great new communicaton protocol invented especially for the Red Matri [zrl=[baseurl]/help/faq_admins]FAQ For Admins[/zrl] [size=large][b]Technical Documentation[/b][/size] -[zrl=[baseurl]/help/Zot---A-High-Level-Overview.md[/zrl]A high level overview of Zot[/zrl] -[zrl=[baseurl]/help/zot]An introduction to Zot/zrl] +[zrl=[baseurl]/help/Zot---A-High-Level-Overview]A high level overview of Zot[/zrl] +[zrl=[baseurl]/help/zot]An introduction to Zot[/zrl] [zrl=[baseurl]/help/zot_structures]Zot Stuctures[/zrl] [zrl=[baseurl]/help/comanche]Comanche Page Descriptions[/zrl] [zrl=[baseurl]/help/Creating-Templates]Creating Comanche Templates[/zrl] diff --git a/view/theme/redbasic/css/style.css b/view/theme/redbasic/css/style.css index 7c203d475..380d6d49c 100644 --- a/view/theme/redbasic/css/style.css +++ b/view/theme/redbasic/css/style.css @@ -2060,11 +2060,11 @@ img.mail-list-sender-photo { .wall-item-ago { color: #777; - font-size: 0.8em; + font-size: 0.833em; } .wall-item-ago i { - font-size: 0.8em; + font-size: 0.833em; } .wall-item-content { @@ -2082,7 +2082,7 @@ img.mail-list-sender-photo { } .comment-icon { - font-size: 0.8em; + font-size: 0.833em; color: $toolicon_colour; } @@ -2256,15 +2256,27 @@ blockquote { } h1, h2 { - font-size: 1.15rem; + font-size: 1.583em; } h3, h4 { - font-size: 1rem; + font-size: 1.334em; } h5, h6 { - font-size: 0.75rem; + font-size: 0.75rem; +} + +.wall-item-content h1, .wall-item-content h2 { + font-size: 1.319em; +} + +.wall-item-title { + font-size: $font_size; +} + +.wall-item-title h3, .wall-item-content h3, .wall-item-content h4 { + font-size: 1.112em; } .dropdown-menu { From 5ea6f27792f378fe21306ce8caef6b86911c3f6f Mon Sep 17 00:00:00 2001 From: friendica Date: Mon, 15 Sep 2014 13:37:57 -0700 Subject: [PATCH 04/32] final piece of the mrjive delivery puzzle, and now we've got most all the tools to implement mod_hubman --- include/notifier.php | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/include/notifier.php b/include/notifier.php index ae781bcf8..3f34d6133 100644 --- a/include/notifier.php +++ b/include/notifier.php @@ -455,8 +455,8 @@ function notifier_run($argv, $argc){ // for public posts always include our own hub - - $sql_extra = (($private) ? "" : " or hubloc_url = '" . dbesc(z_root()) . "' "); +// this shouldn't be needed any more. collect_recipients should take care of it. +// $sql_extra = (($private) ? "" : " or hubloc_url = '" . dbesc(z_root()) . "' "); logger('notifier: hub choice: ' . intval($relay_to_owner) . ' ' . intval($private) . ' ' . $cmd, LOGGER_DEBUG); @@ -478,7 +478,9 @@ function notifier_run($argv, $argc){ } else { $r = q("select hubloc_guid, hubloc_url, hubloc_sitekey, hubloc_network, hubloc_flags, hubloc_callback, hubloc_host from hubloc - where hubloc_hash in (" . implode(',',$recipients) . ") $sql_extra group by hubloc_sitekey"); + where hubloc_hash in (" . implode(',',$recipients) . ") and not (hubloc_flags & %d) group by hubloc_sitekey", + intval(HUBLOC_FLAGS_DELETED) + ); } if(! $r) { @@ -493,6 +495,7 @@ function notifier_run($argv, $argc){ foreach($hubs as $hub) { // don't try to deliver to deleted hublocs - and inexplicably SQL "distinct" and "group by" // both return records with duplicate keys in rare circumstances +// FIXME this is probably redundant now. if((! ($hub['hubloc_flags'] & HUBLOC_FLAGS_DELETED)) && (! in_array($hub['hubloc_sitekey'],$keys))) { $hublist[] = $hub['hubloc_host']; $keys[] = $hub['hubloc_sitekey']; From d2a4b34c98534940c12a2a5f093c7a2f7485b93c Mon Sep 17 00:00:00 2001 From: Thomas Willingham Date: Tue, 16 Sep 2014 00:55:41 +0100 Subject: [PATCH 05/32] Trivial typo - concatenated string that should be. Doesn't really deserve it's own commit, but if I don't fix it now, nobody will notice for another18 months. --- doc/intro_for_developers.bb | 2 +- view/theme/redbasic/php/style.php | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/intro_for_developers.bb b/doc/intro_for_developers.bb index 2f498e6fb..4fb8ed3a9 100644 --- a/doc/intro_for_developers.bb +++ b/doc/intro_for_developers.bb @@ -52,7 +52,7 @@ [li]chatroom - data for the actual chat room[/li] [li]clients - OAuth usage[/li] [li]config - main configuration storage[/li] - [li]conv - [/li] + [li]conv - Diaspora private messages[/li] [li]event - Events[/li] [li]fcontact - friend suggestion stuff[/li] [li]ffinder - friend suggestion stuff[/li] diff --git a/view/theme/redbasic/php/style.php b/view/theme/redbasic/php/style.php index dbe7c306d..cd91fcee7 100644 --- a/view/theme/redbasic/php/style.php +++ b/view/theme/redbasic/php/style.php @@ -64,7 +64,7 @@ if(! $a->install) { // should leave it for admins to define for themselves. if (! $schema) { if(file_exists('view/theme/redbasic/schema/default.php')) { - $schemefile = 'view/theme/redbasic/schema/' . 'default.php'; + $schemefile = 'view/theme/redbasic/schema/default.php'; require_once ($schemefile); } } From bbc9e4427e76761b0607ce2c1a1f5cc7f499b52f Mon Sep 17 00:00:00 2001 From: friendica Date: Mon, 15 Sep 2014 17:17:00 -0700 Subject: [PATCH 06/32] honour service class restrictions for total_identities, total_channels ("friends") and total_feeds both when importing channels and subsequently when syncing clones. Limits are based on the local system - additional entries are silently dropped. --- include/account.php | 23 +++++++++++++++++++++++ include/zot.php | 40 ++++++++++++++++++++++++++++++++++++---- mod/import.php | 29 ++++++++++++++++++++++++++++- 3 files changed, 87 insertions(+), 5 deletions(-) diff --git a/include/account.php b/include/account.php index a3d6ef025..df484e608 100644 --- a/include/account.php +++ b/include/account.php @@ -616,6 +616,29 @@ function service_class_fetch($uid,$property) { return((array_key_exists($property,$arr)) ? $arr[$property] : false); } +// like service_class_fetch but queries by account rather than channel + +function account_service_class_fetch($aid,$property) { + + $r = q("select account_service_class as service_class from account where account_id = %d limit 1", + intval($aid) + ); + if($r !== false && count($r)) { + $service_class = $r[0]['service_class']; + } + + if(! x($service_class)) + return false; // everything is allowed + + $arr = get_config('service_class',$service_class); + + if(! is_array($arr) || (! count($arr))) + return false; + + return((array_key_exists($property,$arr)) ? $arr[$property] : false); +} + + function upgrade_link($bbcode = false) { $l = get_config('service_class','upgrade_link'); if(! $l) diff --git a/include/zot.php b/include/zot.php index f6732037a..add44e288 100644 --- a/include/zot.php +++ b/include/zot.php @@ -2336,7 +2336,7 @@ function build_sync_packet($uid = 0, $packet = null, $groups_changed = false) { function process_channel_sync_delivery($sender,$arr,$deliveries) { // FIXME - this will sync red structures (channel, pconfig and abook). Eventually we need to make this application agnostic. -// TODO: missing group membership changes + $result = array(); @@ -2352,6 +2352,10 @@ function process_channel_sync_delivery($sender,$arr,$deliveries) { $channel = $r[0]; + $max_friends = service_class_fetch($channel['channel_id'],'total_channels'); + $max_feeds = account_service_class_fetch($channel['channel_account_id'],'total_feeds'); + + if($channel['channel_hash'] != $sender['hash']) { logger('process_channel_sync_delivery: possible forgery. Sender ' . $sender['hash'] . ' is not ' . $channel['channel_hash']); $result[] = array($d['hash'],'channel mismatch',$channel['channel_name'],''); @@ -2385,6 +2389,19 @@ function process_channel_sync_delivery($sender,$arr,$deliveries) { if(array_key_exists('abook',$arr) && is_array($arr['abook']) && count($arr['abook'])) { + $total_friends = 0; + $total_feeds = 0; + + $r = q("select abook_id, abook_flags from abook where abook_channel = %d", + intval($channel['channel_id']) + ); + if($r) { + // don't count yourself + $total_friends = ((count($r) > 0) ? $count($r) - 1 : 0); + foreach($r as $rr) + if($rr['abook_flags'] & ABOOK_FLAG_FEED) + $total_feeds ++; + } $disallowed = array('abook_id','abook_account','abook_channel'); @@ -2395,14 +2412,18 @@ function process_channel_sync_delivery($sender,$arr,$deliveries) { logger('process_channel_sync_delivery: removing abook entry for ' . $abook['abook_xchan']); require_once('include/Contact.php'); - $r = q("select abook_id from abook where abook_xchan = '%s' and abook_channel = %d and not ( abook_flags & %d ) limit 1", + $r = q("select abook_id, abook_flags from abook where abook_xchan = '%s' and abook_channel = %d and not ( abook_flags & %d ) limit 1", dbesc($abook['abook_xchan']), intval($channel['channel_id']), intval(ABOOK_FLAG_SELF) ); - if($r) + if($r) { contact_remove($channel['channel_id'],$r[0]['abook_id']); - + if($total_friends) + $total_friends --; + if($r[0]['abook_flags'] & ABOOK_FLAG_FEED) + $total_feeds --; + } continue; } @@ -2449,10 +2470,21 @@ function process_channel_sync_delivery($sender,$arr,$deliveries) { // make sure we have an abook entry for this xchan on this system if(! $r) { + if($max_friends !== false && $total_friends > $max_friends) { + logger('process_channel_sync_delivery: total_channels service class limit exceeded'); + continue; + } + if($max_feeds !== false && ($clean['abook_flags'] & ABOOK_FLAG_FEED) && $total_feeds > $max_feeds) { + logger('process_channel_sync_delivery: total_feeds service class limit exceeded'); + continue; + } q("insert into abook ( abook_xchan, abook_channel ) values ('%s', %d ) ", dbesc($clean['abook_xchan']), intval($channel['channel_id']) ); + $total_friends ++; + if($clean['abook_flags'] & ABOOK_FLAG_FEED) + $total_feeds ++; } if(count($clean)) { diff --git a/mod/import.php b/mod/import.php index 7452bcdc9..22eb688ab 100644 --- a/mod/import.php +++ b/mod/import.php @@ -9,10 +9,25 @@ require_once('include/identity.php'); function import_post(&$a) { - if(! get_account_id()) { + $account_id = get_account_id(); + if(! $account_id) return; + + $max_identities = account_service_class_fetch($account_id,'total_identities'); + $max_friends = account_service_class_fetch($account_id,'total_channels'); + $max_feeds = account_service_class_fetch($account_id,'total_feeds'); + + if($max_identities !== false) { + $r = q("select channel_id from channel where channel_account_id = %d", + intval($account_id) + ); + if($r && count($r) > $max_identities) { + notice( sprintf( t('Your service plan only allows %d channels.'), $max_identities) . EOL); + return; + } } + $data = null; $seize = ((x($_REQUEST,'make_primary')) ? intval($_REQUEST['make_primary']) : 0); @@ -276,10 +291,18 @@ function import_post(&$a) { // FIXME - ensure we have an xchan if somebody is trying to pull a fast one + $friends = 0; + $feeds = 0; + // import contacts $abooks = $data['abook']; if($abooks) { foreach($abooks as $abook) { + if($max_friends !== false && $friends > $max_friends) + continue; + if($max_feeds !== false && ($abook['abook_flags'] & ABOOK_FLAG_FEED) && $feeds > $max_feeds) + continue; + unset($abook['abook_id']); $abook['abook_account'] = get_account_id(); $abook['abook_channel'] = $channel['channel_id']; @@ -289,6 +312,10 @@ function import_post(&$a) { . "`) VALUES ('" . implode("', '", array_values($abook)) . "')" ); + + $friends ++; + if($abook['abook_flags'] & ABOOK_FLAG_FEED) + $feeds ++; } } From 56c1c5cd88dd3686bf39686fd6f76c84714604b3 Mon Sep 17 00:00:00 2001 From: friendica Date: Mon, 15 Sep 2014 17:43:40 -0700 Subject: [PATCH 07/32] couple of edits to make this more current --- doc/intro_for_developers.bb | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/doc/intro_for_developers.bb b/doc/intro_for_developers.bb index 4fb8ed3a9..b44095d3d 100644 --- a/doc/intro_for_developers.bb +++ b/doc/intro_for_developers.bb @@ -16,14 +16,10 @@ [install] Installation and upgrade files and DB schema -[js] core required javascript - [library] Third party modules (must be license compatible) [mod] Controller modules based on URL pathname (e.g. #^[url=http://sitename/foo]http://sitename/foo[/url] loads mod/foo.php) -[spec] protocol specifications - [util] translation tools, main English string database and other miscellaneous utilities [version.inc] contains current version (auto-updated via cron for the master repository and distributed via git) @@ -44,8 +40,7 @@ [li]app - peronal app data[/li] [li]attach - file attachments[/li] [li]auth_codes - OAuth usage[/li] - [li]cache - TBD[/li] - [li]challenge - old DFRN structure, may re-use or may deprecate[/li] + [li]cache - OEmbed cache[/li] [li]channel - replaces Friendica 'user'[/li] [li]chat - chat room content[/li] [li]chatpresence - channel presence information for chat[/li] @@ -62,7 +57,6 @@ [li]group_member - privacy groups[/li] [li]hook - plugin hook registry[/li] [li]hubloc - Red location storage, ties a location to an xchan[/li] - [li]intro - DFRN introductions, may be obsolete[/li] [li]item - posts[/li] [li]item_id - other identifiers on other services for posts[/li] [li]likes - likes of 'things'[/li] From 171719a774f9dc1ea81d11f15b121222bd30a898 Mon Sep 17 00:00:00 2001 From: friendica Date: Mon, 15 Sep 2014 17:59:47 -0700 Subject: [PATCH 08/32] additions and edits to the faq --- doc/faq_users.bb | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/doc/faq_users.bb b/doc/faq_users.bb index 1a864f64a..aac4a114c 100644 --- a/doc/faq_users.bb +++ b/doc/faq_users.bb @@ -2,13 +2,16 @@ [ul] [*][b]I am able to edit a post's text after I saved it, but is there a way to change the permissions?[/b] -Short anser: No, there isn't. This has got some resons. You are able to change permissons to your files, photos and the likes, but not to posts after you have saved them. The reason is: Once you have saved a post it is being distributed either to the public channel and from there to other Red Matrix servers or to those you intended it to go. Just like you cannot reclaim a few after you have sold them off to some people, you cannot change permissions to Red Matrix posts. We would need to track everywhere your posting goes, keep track of everyone you allowed to see it and then keep track of from whom to delete it. -If a posting is public this is even harder, as the Red Matrix is a global network and there is no way to follow a post, let alone reclaim it reliably. -Once you have sent out an email there too is no way to take it back. So think wisely and keep alert when posting. :) -[*][b]I downloaded my channel and uploaded it to another site but there is no content, no posts, no photos. What is wrong???[/b] -To be honest: Nothing. That's the way it is right now. Technically it is surely possible to take at least your own posts and maybe even files with you, but this has simply put not implemented yet. When creating this feature we thought that keeping all your contacts was more important. Once we find someone willing to implement this, it will be done. :) +Short anser: No, there isn't. There are reasons. You are able to change permissons to your files, photos and the likes, but not to posts after you have saved them. The main reason is: Once you have saved a post it is being distributed either to the public channel and from there to other Red Matrix servers or to those you intended it to go. Just like you cannot reclaim something you gave to another person, you cannot change permissions to Red Matrix posts. We would need to track everywhere your posting goes, keep track of everyone you allowed to see it and then keep track of from whom to delete it. +If a posting is public this is even harder, as the Red Matrix is a global network and there is no way to follow a post, let alone reclaim it reliably. Other networks that may receive your post have no reliable way to delete or reclaim the post. +[*][b]I downloaded my channel and imported it (cloned my identity) to another site but there is no content, no posts, no photos. What is wrong???[/b] +To be honest: Nothing. That's the way it is right now. Technically it is surely possible to take at least your own posts and maybe even files with you, but this has simply put not implemented yet. When creating this feature we thought that keeping all your contacts was more important. Your friends have already seen your old content. Once we find someone willing to implement this, it will be done. :) [*][b]I can't see private resources[/b] You have probably disabled third party cookies. You need to enable them for remote authentication to work. +[*][b]There are a lot of foreign language posts. Let's auto-translate them.[/b] +There are also a lot of [b]private[/b] foreign language posts and auto-translation services would require us to transmit these private messages to the translation service; and we don't know what they will do with them on their servers. Actually we do know thanks to Edward Snowden. Our best bet is a project called [b][i]Apertium[/i][/b] which is an open source translator we can install locally. It is currently missing German translations - which are the most requested translation in the matrix. Once again, this will be implemented when we find somebody who really wants to make it happen. [/ul] + + Return to the [zrl=[baseurl]/help/main]Main documentation page[/zrl] From 5f9c326ad7b7ba4a4c84ff2582898414f76267ca Mon Sep 17 00:00:00 2001 From: friendica Date: Mon, 15 Sep 2014 21:31:32 -0700 Subject: [PATCH 09/32] channel export with items --- include/identity.php | 36 +++++++++++++++++++++++++++++++++++- include/widgets.php | 10 +++++----- mod/import.php | 6 ++++++ mod/uexport.php | 2 +- 4 files changed, 47 insertions(+), 7 deletions(-) diff --git a/include/identity.php b/include/identity.php index d8f59e56c..1078ff082 100644 --- a/include/identity.php +++ b/include/identity.php @@ -396,7 +396,7 @@ function set_default_login_identity($account_id,$channel_id,$force = true) { * */ -function identity_basic_export($channel_id) { +function identity_basic_export($channel_id, $items = false) { /* * Red basic channel export @@ -468,8 +468,42 @@ function identity_basic_export($channel_id) { $ret['photo'] = array('type' => $r[0]['type'], 'data' => base64url_encode($r[0]['data'])); } + if(! $items) + return $ret; + + $r = q("select * from item_id where uid = %d", + intval($channel_id) + ); + + if($r) + $ret['item_id'] = $r; + + $key = get_config('system','prvkey'); + + // warning: this may run into memory limits on smaller systems + + $r = q("select * from item where (item_flags & %d) and not (item_restrict & %d) and uid = %d", + intval(ITEM_WALL), + intval(ITEM_DELETED), + intval($channel_id) + ); + if($r) { + for($x = 0; $x < count($r); $x ++) { + if($r[$x]['diaspora_meta']) + $r[$x]['diaspora_meta'] = crypto_unencapsulate(json_decode($r[$x]['diaspora_meta'],true),$key); + if($r[$x]['item_flags'] & ITEM_OBSCURED) { + $r[$x]['item_flags'] = $r[$x]['item_flags'] ^ ITEM_OBSCURED; + if($r[$x]['title']) + $r[$x]['title'] = crypto_unencapsulate(json_decode($r[$x]['title'],true),$key); + if($r[$x]['body']) + $r[$x]['body'] = crypto_unencapsulate(json_decode($r[$x]['body'],true),$key); + } + } + $ret['item'] = $r; + } return $ret; + } diff --git a/include/widgets.php b/include/widgets.php index 1aa018fb6..f1c9ceada 100644 --- a/include/widgets.php +++ b/include/widgets.php @@ -481,11 +481,11 @@ function widget_settings_menu($arr) { 'selected' => '' ), -// array( -// 'label' => t('Export account'), -// 'url' => $a->get_baseurl(true) . '/uexport/complete', -// 'selected' => '' -// ), + array( + 'label' => t('Export content'), + 'url' => $a->get_baseurl(true) . '/uexport/complete', + 'selected' => '' + ), array( 'label' => t('Automatic Permissions (Advanced)'), diff --git a/mod/import.php b/mod/import.php index 22eb688ab..0663a8b57 100644 --- a/mod/import.php +++ b/mod/import.php @@ -376,6 +376,12 @@ function import_post(&$a) { } } +//FIXME just a note here for when folks want to import content - be very careful to unset ITEM_ORIGIN on all imported content. Or you could end up with a nasty routing loop when somebody tries to reply to one of those posts. + + + + + // FIXME - ensure we have a self entry if somebody is trying to pull a fast one if($seize) { diff --git a/mod/uexport.php b/mod/uexport.php index f3a2ce67c..6304115c8 100644 --- a/mod/uexport.php +++ b/mod/uexport.php @@ -18,7 +18,7 @@ function uexport_init(&$a) { } if(argc() > 1 && argv(1) === 'complete') { - echo json_encode('not yet implemented'); + echo json_encode(identity_basic_export(local_user(),true)); killme(); } From 6c0133be1f945215ae5b21c4e6da0fda2817a0a3 Mon Sep 17 00:00:00 2001 From: friendica Date: Mon, 15 Sep 2014 22:23:07 -0700 Subject: [PATCH 10/32] change platform name to redmatrix (lowercase, one word) for use in meta tags and stuff, move yet another oauth1 library to library instead of having it in plugins where we'll end up with a white screen if we re-use it in another plugin; which I plan to do. --- boot.php | 2 +- library/oauth/LICENSE | 37 + library/oauth/LICENSE.txt | 36 + library/oauth/http.php | 2092 ++++++++++++++++++++++++ library/oauth/oauth_client.php | 2176 +++++++++++++++++++++++++ library/oauth/oauth_client_class.html | 607 +++++++ 6 files changed, 4949 insertions(+), 1 deletion(-) create mode 100644 library/oauth/LICENSE create mode 100644 library/oauth/LICENSE.txt create mode 100644 library/oauth/http.php create mode 100644 library/oauth/oauth_client.php create mode 100644 library/oauth/oauth_client_class.html diff --git a/boot.php b/boot.php index 339a1f052..5118038d3 100755 --- a/boot.php +++ b/boot.php @@ -44,7 +44,7 @@ require_once('include/Contact.php'); require_once('include/account.php'); -define ( 'RED_PLATFORM', 'Red Matrix' ); +define ( 'RED_PLATFORM', 'redmatrix' ); define ( 'RED_VERSION', trim(file_get_contents('version.inc')) . 'R'); define ( 'ZOT_REVISION', 1 ); diff --git a/library/oauth/LICENSE b/library/oauth/LICENSE new file mode 100644 index 000000000..7078ba251 --- /dev/null +++ b/library/oauth/LICENSE @@ -0,0 +1,37 @@ +PHP OAuth API - Access API authorized by the users +using the OAuth protocol + +This LICENSE is in the BSD license style. + +License Version Control: +@(#) $Id: LICENSE,v 1.2 2013/02/11 05:17:53 mlemos Exp $ + +Copyright (c) 2012-2013, Manuel Lemos +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions +are met: + + Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + + Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + + Neither the name of Manuel Lemos nor the names of his contributors + may be used to endorse or promote products derived from this software + without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR +CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, +EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, +PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR +PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/library/oauth/LICENSE.txt b/library/oauth/LICENSE.txt new file mode 100644 index 000000000..29e83e173 --- /dev/null +++ b/library/oauth/LICENSE.txt @@ -0,0 +1,36 @@ +HTTP client PHP class + +This LICENSE is in the BSD license style. + +License Version Control: +@(#) $Id: LICENSE.txt,v 1.1 2006/04/17 19:44:04 mlemos Exp $ + +Copyright (c) 1999 - 2006, Manuel Lemos +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions +are met: + + Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + + Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + + Neither the name of Manuel Lemos nor the names of his contributors + may be used to endorse or promote products derived from this software + without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR +CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, +EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, +PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR +PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/library/oauth/http.php b/library/oauth/http.php new file mode 100644 index 000000000..cb336fcfa --- /dev/null +++ b/library/oauth/http.php @@ -0,0 +1,2092 @@ +"01", + "Feb"=>"02", + "Mar"=>"03", + "Apr"=>"04", + "May"=>"05", + "Jun"=>"06", + "Jul"=>"07", + "Aug"=>"08", + "Sep"=>"09", + "Oct"=>"10", + "Nov"=>"11", + "Dec"=>"12"); + var $session=''; + var $connection_close=0; + var $force_close = 0; + var $connected_host = ''; + var $connected_port = -1; + var $connected_ssl = 0; + + /* Private methods - DO NOT CALL */ + + Function Tokenize($string,$separator="") + { + if(!strcmp($separator,"")) + { + $separator=$string; + $string=$this->next_token; + } + for($character=0;$characternext_token=substr($string,$found+1); + return(substr($string,0,$found)); + } + else + { + $this->next_token=""; + return($string); + } + } + + Function CookieEncode($value, $name) + { + return($name ? str_replace("=", "%25", $value) : str_replace(";", "%3B", $value)); + } + + Function SetError($error, $error_code = HTTP_CLIENT_ERROR_UNSPECIFIED_ERROR) + { + $this->error_code = $error_code; + return($this->error=$error); + } + + Function SetPHPError($error, &$php_error_message, $error_code = HTTP_CLIENT_ERROR_UNSPECIFIED_ERROR) + { + if(IsSet($php_error_message) + && strlen($php_error_message)) + $error.=": ".$php_error_message; + return($this->SetError($error, $error_code)); + } + + Function SetDataAccessError($error,$check_connection=0) + { + $this->error=$error; + $this->error_code = HTTP_CLIENT_ERROR_COMMUNICATION_FAILURE; + if(!$this->use_curl + && function_exists("socket_get_status")) + { + $status=socket_get_status($this->connection); + if($status["timed_out"]) + $this->error.=": data access time out"; + elseif($status["eof"]) + { + if($check_connection) + $this->error=""; + else + $this->error.=": the server disconnected"; + } + } + } + + Function OutputDebug($message) + { + if($this->log_debug) + error_log($message); + else + { + $message.="\n"; + if($this->html_debug) + $message=str_replace("\n","
\n",HtmlEntities($message)); + echo $message; + flush(); + } + } + + Function GetLine() + { + for($line="";;) + { + if($this->use_curl) + { + $eol=strpos($this->response,"\n",$this->read_response); + $data=($eol ? substr($this->response,$this->read_response,$eol+1-$this->read_response) : ""); + $this->read_response+=strlen($data); + } + else + { + if(feof($this->connection)) + { + $this->SetDataAccessError("reached the end of data while reading from the HTTP server connection"); + return(0); + } + $data=fgets($this->connection,100); + } + if(GetType($data)!="string" + || strlen($data)==0) + { + $this->SetDataAccessError("it was not possible to read line from the HTTP server"); + return(0); + } + $line.=$data; + $length=strlen($line); + if($length + && !strcmp(substr($line,$length-1,1),"\n")) + { + $length-=(($length>=2 && !strcmp(substr($line,$length-2,1),"\r")) ? 2 : 1); + $line=substr($line,0,$length); + if($this->debug) + $this->OutputDebug("S $line"); + return($line); + } + } + } + + Function PutLine($line) + { + if($this->debug) + $this->OutputDebug("C $line"); + if(!fputs($this->connection,$line."\r\n")) + { + $this->SetDataAccessError("it was not possible to send a line to the HTTP server"); + return(0); + } + return(1); + } + + Function PutData($data) + { + if(strlen($data)) + { + if($this->debug) + $this->OutputDebug('C '.$data); + if(!fputs($this->connection,$data)) + { + $this->SetDataAccessError("it was not possible to send data to the HTTP server"); + return(0); + } + } + return(1); + } + + Function FlushData() + { + if(!fflush($this->connection)) + { + $this->SetDataAccessError("it was not possible to send data to the HTTP server"); + return(0); + } + return(1); + } + + Function ReadChunkSize() + { + if($this->remaining_chunk==0) + { + $debug=$this->debug; + if(!$this->debug_response_body) + $this->debug=0; + $line=$this->GetLine(); + $this->debug=$debug; + if(GetType($line)!="string") + return($this->SetError("could not read chunk start: ".$this->error, $this->error_code)); + $this->remaining_chunk=hexdec($line); + if($this->remaining_chunk == 0) + { + if(!$this->debug_response_body) + $this->debug=0; + $line=$this->GetLine(); + $this->debug=$debug; + if(GetType($line)!="string") + return($this->SetError("could not read chunk end: ".$this->error, $this->error_code)); + } + } + return(""); + } + + Function ReadBytes($length) + { + if($this->use_curl) + { + $bytes=substr($this->response,$this->read_response,min($length,strlen($this->response)-$this->read_response)); + $this->read_response+=strlen($bytes); + if($this->debug + && $this->debug_response_body + && strlen($bytes)) + $this->OutputDebug("S ".$bytes); + } + else + { + if($this->chunked) + { + for($bytes="",$remaining=$length;$remaining;) + { + if(strlen($this->ReadChunkSize())) + return(""); + if($this->remaining_chunk==0) + { + $this->last_chunk_read=1; + break; + } + $ask=min($this->remaining_chunk,$remaining); + $chunk=@fread($this->connection,$ask); + $read=strlen($chunk); + if($read==0) + { + $this->SetDataAccessError("it was not possible to read data chunk from the HTTP server"); + return(""); + } + if($this->debug + && $this->debug_response_body) + $this->OutputDebug("S ".$chunk); + $bytes.=$chunk; + $this->remaining_chunk-=$read; + $remaining-=$read; + if($this->remaining_chunk==0) + { + if(feof($this->connection)) + return($this->SetError("reached the end of data while reading the end of data chunk mark from the HTTP server", HTTP_CLIENT_ERROR_PROTOCOL_FAILURE)); + $data=@fread($this->connection,2); + if(strcmp($data,"\r\n")) + { + $this->SetDataAccessError("it was not possible to read end of data chunk from the HTTP server"); + return(""); + } + } + } + } + else + { + $bytes=@fread($this->connection,$length); + if(strlen($bytes)) + { + if($this->debug + && $this->debug_response_body) + $this->OutputDebug("S ".$bytes); + } + else + $this->SetDataAccessError("it was not possible to read data from the HTTP server", $this->connection_close); + } + } + return($bytes); + } + + Function EndOfInput() + { + if($this->use_curl) + return($this->read_response>=strlen($this->response)); + if($this->chunked) + return($this->last_chunk_read); + if($this->content_length_set) + return($this->content_length <= $this->read_length); + return(feof($this->connection)); + } + + Function Resolve($domain, &$ip, $server_type) + { + if(preg_match('/^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$/',$domain)) + $ip=$domain; + else + { + if($this->debug) + $this->OutputDebug('Resolving '.$server_type.' server domain "'.$domain.'"...'); + if(!strcmp($ip=@gethostbyname($domain),$domain)) + $ip=""; + } + if(strlen($ip)==0 + || (strlen($this->exclude_address) + && !strcmp(@gethostbyname($this->exclude_address),$ip))) + return($this->SetError("could not resolve the host domain \"".$domain."\"", HTTP_CLIENT_ERROR_INVALID_SERVER_ADDRESS)); + return(''); + } + + Function Connect($host_name, $host_port, $ssl, $server_type = 'HTTP') + { + $domain=$host_name; + $port = $host_port; + if(strlen($error = $this->Resolve($domain, $ip, $server_type))) + return($error); + if(strlen($this->socks_host_name)) + { + switch($this->socks_version) + { + case '4': + $version = 4; + break; + case '5': + $version = 5; + break; + default: + return('it was not specified a supported SOCKS protocol version'); + break; + } + $host_ip = $ip; + $port = $this->socks_host_port; + $host_server_type = $server_type; + $server_type = 'SOCKS'; + if(strlen($error = $this->Resolve($this->socks_host_name, $ip, $server_type))) + return($error); + } + if($this->debug) + $this->OutputDebug('Connecting to '.$server_type.' server IP '.$ip.' port '.$port.'...'); + if($ssl) + $ip="ssl://".$host_name; + if(($this->connection=($this->timeout ? @fsockopen($ip, $port, $errno, $error, $this->timeout) : @fsockopen($ip, $port, $errno)))==0) + { + $error_code = HTTP_CLIENT_ERROR_CANNOT_CONNECT; + switch($errno) + { + case -3: + return($this->SetError("socket could not be created", $error_code)); + case -4: + return($this->SetError("dns lookup on hostname \"".$host_name."\" failed", $error_code)); + case -5: + return($this->SetError("connection refused or timed out", $error_code)); + case -6: + return($this->SetError("fdopen() call failed", $error_code)); + case -7: + return($this->SetError("setvbuf() call failed", $error_code)); + default: + return($this->SetPHPError($errno." could not connect to the host \"".$host_name."\"",$php_errormsg, $error_code)); + } + } + else + { + if($this->data_timeout + && function_exists("socket_set_timeout")) + socket_set_timeout($this->connection,$this->data_timeout,0); + if(strlen($this->socks_host_name)) + { + if($this->debug) + $this->OutputDebug('Connected to the SOCKS server '.$this->socks_host_name); + $send_error = 'it was not possible to send data to the SOCKS server'; + $receive_error = 'it was not possible to receive data from the SOCKS server'; + switch($version) + { + case 4: + $command = 1; + $user = ''; + if(!fputs($this->connection, chr($version).chr($command).pack('nN', $host_port, ip2long($host_ip)).$user.Chr(0))) + $error = $this->SetDataAccessError($send_error); + else + { + $response = fgets($this->connection, 9); + if(strlen($response) != 8) + $error = $this->SetDataAccessError($receive_error); + else + { + $socks_errors = array( + "\x5a"=>'', + "\x5b"=>'request rejected', + "\x5c"=>'request failed because client is not running identd (or not reachable from the server)', + "\x5d"=>'request failed because client\'s identd could not confirm the user ID string in the request', + ); + $error_code = $response[1]; + $error = (IsSet($socks_errors[$error_code]) ? $socks_errors[$error_code] : 'unknown'); + if(strlen($error)) + $error = 'SOCKS error: '.$error; + } + } + break; + case 5: + if($this->debug) + $this->OutputDebug('Negotiating the authentication method ...'); + $methods = 1; + $method = 0; + if(!fputs($this->connection, chr($version).chr($methods).chr($method))) + $error = $this->SetDataAccessError($send_error); + else + { + $response = fgets($this->connection, 3); + if(strlen($response) != 2) + $error = $this->SetDataAccessError($receive_error); + elseif(Ord($response[1]) != $method) + $error = 'the SOCKS server requires an authentication method that is not yet supported'; + else + { + if($this->debug) + $this->OutputDebug('Connecting to '.$host_server_type.' server IP '.$host_ip.' port '.$host_port.'...'); + $command = 1; + $address_type = 1; + if(!fputs($this->connection, chr($version).chr($command)."\x00".chr($address_type).pack('Nn', ip2long($host_ip), $host_port))) + $error = $this->SetDataAccessError($send_error); + else + { + $response = fgets($this->connection, 11); + if(strlen($response) != 10) + $error = $this->SetDataAccessError($receive_error); + else + { + $socks_errors = array( + "\x00"=>'', + "\x01"=>'general SOCKS server failure', + "\x02"=>'connection not allowed by ruleset', + "\x03"=>'Network unreachable', + "\x04"=>'Host unreachable', + "\x05"=>'Connection refused', + "\x06"=>'TTL expired', + "\x07"=>'Command not supported', + "\x08"=>'Address type not supported' + ); + $error_code = $response[1]; + $error = (IsSet($socks_errors[$error_code]) ? $socks_errors[$error_code] : 'unknown'); + if(strlen($error)) + $error = 'SOCKS error: '.$error; + } + } + } + } + break; + default: + $error = 'support for SOCKS protocol version '.$this->socks_version.' is not yet implemented'; + break; + } + if(strlen($error)) + { + fclose($this->connection); + return($error); + } + } + if($this->debug) + $this->OutputDebug("Connected to $host_name"); + if(strlen($this->proxy_host_name) + && !strcmp(strtolower($this->protocol), 'https')) + { + if(function_exists('stream_socket_enable_crypto') + && in_array('ssl', stream_get_transports())) + $this->state = "ConnectedToProxy"; + else + { + $this->OutputDebug("It is not possible to start SSL after connecting to the proxy server. If the proxy refuses to forward the SSL request, you may need to upgrade to PHP 5.1 or later with OpenSSL support enabled."); + $this->state="Connected"; + } + } + else + $this->state="Connected"; + return(""); + } + } + + Function Disconnect() + { + if($this->debug) + $this->OutputDebug("Disconnected from ".$this->connected_host); + if($this->use_curl) + { + curl_close($this->connection); + $this->response=""; + } + else + fclose($this->connection); + $this->state="Disconnected"; + return(""); + } + + /* Public methods */ + + Function GetRequestArguments($url, &$arguments) + { + $this->error = ''; + $this->error_code = HTTP_CLIENT_ERROR_NO_ERROR; + $arguments=array(); + $url = str_replace(' ', '%20', $url); + $parameters=@parse_url($url); + if(!$parameters) + return($this->SetError("it was not specified a valid URL", HTTP_CLIENT_ERROR_INVALID_PARAMETERS)); + if(!IsSet($parameters["scheme"])) + return($this->SetError("it was not specified the protocol type argument", HTTP_CLIENT_ERROR_INVALID_PARAMETERS)); + switch(strtolower($parameters["scheme"])) + { + case "http": + case "https": + $arguments["Protocol"]=$parameters["scheme"]; + break; + default: + return($parameters["scheme"]." connection scheme is not yet supported"); + } + if(!IsSet($parameters["host"])) + return($this->SetError("it was not specified the connection host argument", HTTP_CLIENT_ERROR_INVALID_PARAMETERS)); + $arguments["HostName"]=$parameters["host"]; + $arguments["Headers"]=array("Host"=>$parameters["host"].(IsSet($parameters["port"]) ? ":".$parameters["port"] : "")); + if(IsSet($parameters["user"])) + { + $arguments["AuthUser"]=UrlDecode($parameters["user"]); + if(!IsSet($parameters["pass"])) + $arguments["AuthPassword"]=""; + } + if(IsSet($parameters["pass"])) + { + if(!IsSet($parameters["user"])) + $arguments["AuthUser"]=""; + $arguments["AuthPassword"]=UrlDecode($parameters["pass"]); + } + if(IsSet($parameters["port"])) + { + if(strcmp($parameters["port"],strval(intval($parameters["port"])))) + return($this->SetError("it was not specified a valid connection host argument", HTTP_CLIENT_ERROR_INVALID_PARAMETERS)); + $arguments["HostPort"]=intval($parameters["port"]); + } + else + $arguments["HostPort"]=0; + $arguments["RequestURI"]=(IsSet($parameters["path"]) ? $parameters["path"] : "/").(IsSet($parameters["query"]) ? "?".$parameters["query"] : ""); + if(strlen($this->user_agent)) + $arguments["Headers"]["User-Agent"]=$this->user_agent; + if(strlen($this->accept)) + $arguments["Headers"]["Accept"]=$this->accept; + return(""); + } + + Function Open($arguments) + { + if(strlen($this->error)) + return($this->error); + $error_code = HTTP_CLIENT_ERROR_UNSPECIFIED_ERROR; + if(IsSet($arguments["HostName"])) + $this->host_name=$arguments["HostName"]; + if(IsSet($arguments["HostPort"])) + $this->host_port=$arguments["HostPort"]; + if(IsSet($arguments["ProxyHostName"])) + $this->proxy_host_name=$arguments["ProxyHostName"]; + if(IsSet($arguments["ProxyHostPort"])) + $this->proxy_host_port=$arguments["ProxyHostPort"]; + if(IsSet($arguments["SOCKSHostName"])) + $this->socks_host_name=$arguments["SOCKSHostName"]; + if(IsSet($arguments["SOCKSHostPort"])) + $this->socks_host_port=$arguments["SOCKSHostPort"]; + if(IsSet($arguments["SOCKSVersion"])) + $this->socks_version=$arguments["SOCKSVersion"]; + if(IsSet($arguments["Protocol"])) + $this->protocol=$arguments["Protocol"]; + switch(strtolower($this->protocol)) + { + case "http": + $default_port=80; + break; + case "https": + $default_port=443; + break; + default: + return($this->SetError("it was not specified a valid connection protocol", HTTP_CLIENT_ERROR_INVALID_PARAMETERS)); + } + if(strlen($this->proxy_host_name)==0) + { + if(strlen($this->host_name)==0) + return($this->SetError("it was not specified a valid hostname", HTTP_CLIENT_ERROR_INVALID_PARAMETERS)); + $host_name=$this->host_name; + $host_port=($this->host_port ? $this->host_port : $default_port); + $server_type = 'HTTP'; + } + else + { + $host_name=$this->proxy_host_name; + $host_port=$this->proxy_host_port; + $server_type = 'HTTP proxy'; + } + $ssl=(strtolower($this->protocol)=="https" && strlen($this->proxy_host_name)==0); + if($ssl + && strlen($this->socks_host_name)) + return($this->SetError('establishing SSL connections via a SOCKS server is not yet supported', HTTP_CLIENT_ERROR_INVALID_PARAMETERS)); + $this->use_curl=($ssl && $this->prefer_curl && function_exists("curl_init")); + switch($this->state) + { + case 'Connected': + if(!strcmp($host_name, $this->connected_host) + && intval($host_port) == $this->connected_port + && intval($ssl) == $this->connected_ssl) + { + if($this->debug) + $this->OutputDebug("Reusing connection to ".$this->connected_host); + return(''); + } + if(strlen($error = $this->Disconnect())) + return($error); + case "Disconnected": + break; + default: + return("1 already connected"); + } + if($this->debug) + $this->OutputDebug("Connecting to ".$this->host_name); + if($this->use_curl) + { + $error=(($this->connection=curl_init($this->protocol."://".$this->host_name.($host_port==$default_port ? "" : ":".strval($host_port))."/")) ? "" : "Could not initialize a CURL session"); + if(strlen($error)==0) + { + if(IsSet($arguments["SSLCertificateFile"])) + curl_setopt($this->connection,CURLOPT_SSLCERT,$arguments["SSLCertificateFile"]); + if(IsSet($arguments["SSLCertificatePassword"])) + curl_setopt($this->connection,CURLOPT_SSLCERTPASSWD,$arguments["SSLCertificatePassword"]); + if(IsSet($arguments["SSLKeyFile"])) + curl_setopt($this->connection,CURLOPT_SSLKEY,$arguments["SSLKeyFile"]); + if(IsSet($arguments["SSLKeyPassword"])) + curl_setopt($this->connection,CURLOPT_SSLKEYPASSWD,$arguments["SSLKeyPassword"]); + } + $this->state="Connected"; + } + else + { + $error=""; + if(strlen($this->proxy_host_name) + && (IsSet($arguments["SSLCertificateFile"]) + || IsSet($arguments["SSLCertificateFile"]))) + $error="establishing SSL connections using certificates or private keys via non-SSL proxies is not supported"; + else + { + if($ssl) + { + if(IsSet($arguments["SSLCertificateFile"])) + $error="establishing SSL connections using certificates is only supported when the cURL extension is enabled"; + elseif(IsSet($arguments["SSLKeyFile"])) + $error="establishing SSL connections using a private key is only supported when the cURL extension is enabled"; + else + { + $version=explode(".",function_exists("phpversion") ? phpversion() : "3.0.7"); + $php_version=intval($version[0])*1000000+intval($version[1])*1000+intval($version[2]); + if($php_version<4003000) + $error="establishing SSL connections requires at least PHP version 4.3.0 or having the cURL extension enabled"; + elseif(!function_exists("extension_loaded") + || !extension_loaded("openssl")) + $error="establishing SSL connections requires the OpenSSL extension enabled"; + } + } + if(strlen($error)==0) + { + $error=$this->Connect($host_name, $host_port, $ssl, $server_type); + $error_code = $this->error_code; + } + } + } + if(strlen($error)) + return($this->SetError($error, $error_code)); + $this->session=md5(uniqid("")); + $this->connected_host = $host_name; + $this->connected_port = intval($host_port); + $this->connected_ssl = intval($ssl); + return(""); + } + + Function Close($force = 0) + { + if($this->state=="Disconnected") + return("1 already disconnected"); + if(!$this->force_close + && $this->keep_alive + && !$force + && $this->state == 'ResponseReceived') + { + if($this->debug) + $this->OutputDebug('Keeping the connection alive to '.$this->connected_host); + $this->state = 'Connected'; + return(''); + } + return($this->Disconnect()); + } + + Function PickCookies(&$cookies,$secure) + { + if(IsSet($this->cookies[$secure])) + { + $now=gmdate("Y-m-d H-i-s"); + for($domain=0,Reset($this->cookies[$secure]);$domaincookies[$secure]);Next($this->cookies[$secure]),$domain++) + { + $domain_pattern=Key($this->cookies[$secure]); + $match=strlen($this->request_host)-strlen($domain_pattern); + if($match>=0 + && !strcmp($domain_pattern,substr($this->request_host,$match)) + && ($match==0 + || $domain_pattern[0]=="." + || $this->request_host[$match-1]==".")) + { + for(Reset($this->cookies[$secure][$domain_pattern]),$path_part=0;$path_partcookies[$secure][$domain_pattern]);Next($this->cookies[$secure][$domain_pattern]),$path_part++) + { + $path=Key($this->cookies[$secure][$domain_pattern]); + if(strlen($this->request_uri)>=strlen($path) + && substr($this->request_uri,0,strlen($path))==$path) + { + for(Reset($this->cookies[$secure][$domain_pattern][$path]),$cookie=0;$cookiecookies[$secure][$domain_pattern][$path]);Next($this->cookies[$secure][$domain_pattern][$path]),$cookie++) + { + $cookie_name=Key($this->cookies[$secure][$domain_pattern][$path]); + $expires=$this->cookies[$secure][$domain_pattern][$path][$cookie_name]["expires"]; + if($expires=="" + || strcmp($now,$expires)<0) + $cookies[$cookie_name]=$this->cookies[$secure][$domain_pattern][$path][$cookie_name]; + } + } + } + } + } + } + } + + Function GetFileDefinition($file, &$definition) + { + $name=""; + if(IsSet($file["FileName"])) + $name=basename($file["FileName"]); + if(IsSet($file["Name"])) + $name=$file["Name"]; + if(strlen($name)==0) + return("it was not specified the file part name"); + if(IsSet($file["Content-Type"])) + { + $content_type=$file["Content-Type"]; + $type=$this->Tokenize(strtolower($content_type),"/"); + $sub_type=$this->Tokenize(""); + switch($type) + { + case "text": + case "image": + case "audio": + case "video": + case "application": + case "message": + break; + case "automatic": + switch($sub_type) + { + case "name": + switch(GetType($dot=strrpos($name,"."))=="integer" ? strtolower(substr($name,$dot)) : "") + { + case ".xls": + $content_type="application/excel"; + break; + case ".hqx": + $content_type="application/macbinhex40"; + break; + case ".doc": + case ".dot": + case ".wrd": + $content_type="application/msword"; + break; + case ".pdf": + $content_type="application/pdf"; + break; + case ".pgp": + $content_type="application/pgp"; + break; + case ".ps": + case ".eps": + case ".ai": + $content_type="application/postscript"; + break; + case ".ppt": + $content_type="application/powerpoint"; + break; + case ".rtf": + $content_type="application/rtf"; + break; + case ".tgz": + case ".gtar": + $content_type="application/x-gtar"; + break; + case ".gz": + $content_type="application/x-gzip"; + break; + case ".php": + case ".php3": + $content_type="application/x-httpd-php"; + break; + case ".js": + $content_type="application/x-javascript"; + break; + case ".ppd": + case ".psd": + $content_type="application/x-photoshop"; + break; + case ".swf": + case ".swc": + case ".rf": + $content_type="application/x-shockwave-flash"; + break; + case ".tar": + $content_type="application/x-tar"; + break; + case ".zip": + $content_type="application/zip"; + break; + case ".mid": + case ".midi": + case ".kar": + $content_type="audio/midi"; + break; + case ".mp2": + case ".mp3": + case ".mpga": + $content_type="audio/mpeg"; + break; + case ".ra": + $content_type="audio/x-realaudio"; + break; + case ".wav": + $content_type="audio/wav"; + break; + case ".bmp": + $content_type="image/bitmap"; + break; + case ".gif": + $content_type="image/gif"; + break; + case ".iff": + $content_type="image/iff"; + break; + case ".jb2": + $content_type="image/jb2"; + break; + case ".jpg": + case ".jpe": + case ".jpeg": + $content_type="image/jpeg"; + break; + case ".jpx": + $content_type="image/jpx"; + break; + case ".png": + $content_type="image/png"; + break; + case ".tif": + case ".tiff": + $content_type="image/tiff"; + break; + case ".wbmp": + $content_type="image/vnd.wap.wbmp"; + break; + case ".xbm": + $content_type="image/xbm"; + break; + case ".css": + $content_type="text/css"; + break; + case ".txt": + $content_type="text/plain"; + break; + case ".htm": + case ".html": + $content_type="text/html"; + break; + case ".xml": + $content_type="text/xml"; + break; + case ".mpg": + case ".mpe": + case ".mpeg": + $content_type="video/mpeg"; + break; + case ".qt": + case ".mov": + $content_type="video/quicktime"; + break; + case ".avi": + $content_type="video/x-ms-video"; + break; + case ".eml": + $content_type="message/rfc822"; + break; + default: + $content_type="application/octet-stream"; + break; + } + break; + default: + return($content_type." is not a supported automatic content type detection method"); + } + break; + default: + return($content_type." is not a supported file content type"); + } + } + else + $content_type="application/octet-stream"; + $definition=array( + "Content-Type"=>$content_type, + "NAME"=>$name + ); + if(IsSet($file["FileName"])) + { + if(GetType($length=@filesize($file["FileName"]))!="integer") + { + $error="it was not possible to determine the length of the file ".$file["FileName"]; + if(IsSet($php_errormsg) + && strlen($php_errormsg)) + $error.=": ".$php_errormsg; + if(!file_exists($file["FileName"])) + $error="it was not possible to access the file ".$file["FileName"]; + return($error); + } + $definition["FILENAME"]=$file["FileName"]; + $definition["Content-Length"]=$length; + } + elseif(IsSet($file["Data"])) + $definition["Content-Length"]=strlen($definition["DATA"]=$file["Data"]); + else + return("it was not specified a valid file name"); + return(""); + } + + Function ConnectFromProxy($arguments, &$headers) + { + if(!$this->PutLine('CONNECT '.$this->host_name.':'.($this->host_port ? $this->host_port : 443).' HTTP/1.0') + || (strlen($this->user_agent) + && !$this->PutLine('User-Agent: '.$this->user_agent)) + || (strlen($this->accept) + && !$this->PutLine('Accept: '.$this->accept)) + || (IsSet($arguments['Headers']['Proxy-Authorization']) + && !$this->PutLine('Proxy-Authorization: '.$arguments['Headers']['Proxy-Authorization'])) + || !$this->PutLine('')) + { + $this->Disconnect(); + return($this->error); + } + $this->state = "ConnectSent"; + if(strlen($error=$this->ReadReplyHeadersResponse($headers))) + return($error); + $proxy_authorization=""; + while(!strcmp($this->response_status, "100")) + { + $this->state="ConnectSent"; + if(strlen($error=$this->ReadReplyHeadersResponse($headers))) + return($error); + } + switch($this->response_status) + { + case "200": + if(!@stream_socket_enable_crypto($this->connection, 1, STREAM_CRYPTO_METHOD_SSLv23_CLIENT)) + { + $this->SetPHPError('it was not possible to start a SSL encrypted connection via this proxy', $php_errormsg, HTTP_CLIENT_ERROR_COMMUNICATION_FAILURE); + $this->Disconnect(); + return($this->error); + } + $this->state = "Connected"; + break; + case "407": + if(strlen($error=$this->Authenticate($headers, -1, $proxy_authorization, $this->proxy_request_user, $this->proxy_request_password, $this->proxy_request_realm, $this->proxy_request_workstation))) + return($error); + break; + default: + return($this->SetError("unable to send request via proxy", HTTP_CLIENT_ERROR_PROTOCOL_FAILURE)); + } + return(""); + } + + Function SendRequest($arguments) + { + if(strlen($this->error)) + return($this->error); + if(IsSet($arguments["ProxyUser"])) + $this->proxy_request_user=$arguments["ProxyUser"]; + elseif(IsSet($this->proxy_user)) + $this->proxy_request_user=$this->proxy_user; + if(IsSet($arguments["ProxyPassword"])) + $this->proxy_request_password=$arguments["ProxyPassword"]; + elseif(IsSet($this->proxy_password)) + $this->proxy_request_password=$this->proxy_password; + if(IsSet($arguments["ProxyRealm"])) + $this->proxy_request_realm=$arguments["ProxyRealm"]; + elseif(IsSet($this->proxy_realm)) + $this->proxy_request_realm=$this->proxy_realm; + if(IsSet($arguments["ProxyWorkstation"])) + $this->proxy_request_workstation=$arguments["ProxyWorkstation"]; + elseif(IsSet($this->proxy_workstation)) + $this->proxy_request_workstation=$this->proxy_workstation; + switch($this->state) + { + case "Disconnected": + return($this->SetError("connection was not yet established", HTTP_CLIENT_ERROR_INVALID_PARAMETERS)); + case "Connected": + $connect = 0; + break; + case "ConnectedToProxy": + if(strlen($error = $this->ConnectFromProxy($arguments, $headers))) + return($error); + $connect = 1; + break; + default: + return($this->SetError("can not send request in the current connection state", HTTP_CLIENT_ERROR_INVALID_PARAMETERS)); + } + if(IsSet($arguments["RequestMethod"])) + $this->request_method=$arguments["RequestMethod"]; + if(IsSet($arguments["User-Agent"])) + $this->user_agent=$arguments["User-Agent"]; + if(!IsSet($arguments["Headers"]["User-Agent"]) + && strlen($this->user_agent)) + $arguments["Headers"]["User-Agent"]=$this->user_agent; + if(IsSet($arguments["KeepAlive"])) + $this->keep_alive=intval($arguments["KeepAlive"]); + if(!IsSet($arguments["Headers"]["Connection"]) + && $this->keep_alive) + $arguments["Headers"]["Connection"]='Keep-Alive'; + if(IsSet($arguments["Accept"])) + $this->user_agent=$arguments["Accept"]; + if(!IsSet($arguments["Headers"]["Accept"]) + && strlen($this->accept)) + $arguments["Headers"]["Accept"]=$this->accept; + if(strlen($this->request_method)==0) + return($this->SetError("it was not specified a valid request method", HTTP_CLIENT_ERROR_INVALID_PARAMETERS)); + if(IsSet($arguments["RequestURI"])) + $this->request_uri=$arguments["RequestURI"]; + if(strlen($this->request_uri)==0 + || substr($this->request_uri,0,1)!="/") + return($this->SetError("it was not specified a valid request URI", HTTP_CLIENT_ERROR_INVALID_PARAMETERS)); + $this->request_arguments=$arguments; + $this->request_headers=(IsSet($arguments["Headers"]) ? $arguments["Headers"] : array()); + $body_length=0; + $this->request_body=""; + $get_body=1; + if($this->request_method=="POST" + || $this->request_method=="PUT") + { + if(IsSet($arguments['StreamRequest'])) + { + $get_body = 0; + $this->request_headers["Transfer-Encoding"]="chunked"; + } + elseif(IsSet($arguments["PostFiles"]) + || ($this->force_multipart_form_post + && IsSet($arguments["PostValues"]))) + { + $boundary="--".md5(uniqid(time())); + $this->request_headers["Content-Type"]="multipart/form-data; boundary=".$boundary.(IsSet($arguments["CharSet"]) ? "; charset=".$arguments["CharSet"] : ""); + $post_parts=array(); + if(IsSet($arguments["PostValues"])) + { + $values=$arguments["PostValues"]; + if(GetType($values)!="array") + return($this->SetError("it was not specified a valid POST method values array", HTTP_CLIENT_ERROR_INVALID_PARAMETERS)); + for(Reset($values),$value=0;$value$headers,"DATA"=>$data); + $body_length+=strlen($headers)+strlen($data)+strlen("\r\n"); + } + } + $body_length+=strlen("--".$boundary."--\r\n"); + $files=(IsSet($arguments["PostFiles"]) ? $arguments["PostFiles"] : array()); + Reset($files); + $end=(GetType($input=Key($files))!="string"); + for(;!$end;) + { + if(strlen($error=$this->GetFileDefinition($files[$input],$definition))) + return("3 ".$error); + $headers="--".$boundary."\r\nContent-Disposition: form-data; name=\"".$input."\"; filename=\"".$definition["NAME"]."\"\r\nContent-Type: ".$definition["Content-Type"]."\r\n\r\n"; + $part=count($post_parts); + $post_parts[$part]=array("HEADERS"=>$headers); + if(IsSet($definition["FILENAME"])) + { + $post_parts[$part]["FILENAME"]=$definition["FILENAME"]; + $data=""; + } + else + $data=$definition["DATA"]; + $post_parts[$part]["DATA"]=$data; + $body_length+=strlen($headers)+$definition["Content-Length"]+strlen("\r\n"); + Next($files); + $end=(GetType($input=Key($files))!="string"); + } + $get_body=0; + } + elseif(IsSet($arguments["PostValues"])) + { + $values=$arguments["PostValues"]; + if(GetType($values)!="array") + return($this->SetError("it was not specified a valid POST method values array", HTTP_CLIENT_ERROR_INVALID_PARAMETERS)); + for(Reset($values),$value=0;$value0) + $this->request_body.="&"; + $this->request_body.=UrlEncode($k)."=".UrlEncode($values[$k][$v]); + } + } + else + { + if($value>0) + $this->request_body.="&"; + $this->request_body.=UrlEncode($k)."=".UrlEncode($values[$k]); + } + } + $this->request_headers["Content-Type"]="application/x-www-form-urlencoded".(IsSet($arguments["CharSet"]) ? "; charset=".$arguments["CharSet"] : ""); + $get_body=0; + } + } + if($get_body + && (IsSet($arguments["Body"]) + || IsSet($arguments["BodyStream"]))) + { + if(IsSet($arguments["Body"])) + $this->request_body=$arguments["Body"]; + else + { + $stream=$arguments["BodyStream"]; + $this->request_body=""; + for($part=0; $partrequest_body.=$stream[$part]["Data"]; + elseif(IsSet($stream[$part]["File"])) + { + if(!($file=@fopen($stream[$part]["File"],"rb"))) + return($this->SetPHPError("could not open upload file ".$stream[$part]["File"], $php_errormsg, HTTP_CLIENT_ERROR_CANNOT_ACCESS_LOCAL_FILE)); + while(!feof($file)) + { + if(GetType($block=@fread($file,$this->file_buffer_length))!="string") + { + $error=$this->SetPHPError("could not read body stream file ".$stream[$part]["File"], $php_errormsg, HTTP_CLIENT_ERROR_CANNOT_ACCESS_LOCAL_FILE); + fclose($file); + return($error); + } + $this->request_body.=$block; + } + fclose($file); + } + else + return("5 it was not specified a valid file or data body stream element at position ".$part); + } + } + if(!IsSet($this->request_headers["Content-Type"])) + $this->request_headers["Content-Type"]="application/octet-stream".(IsSet($arguments["CharSet"]) ? "; charset=".$arguments["CharSet"] : ""); + } + if(IsSet($arguments["AuthUser"])) + $this->request_user=$arguments["AuthUser"]; + elseif(IsSet($this->user)) + $this->request_user=$this->user; + if(IsSet($arguments["AuthPassword"])) + $this->request_password=$arguments["AuthPassword"]; + elseif(IsSet($this->password)) + $this->request_password=$this->password; + if(IsSet($arguments["AuthRealm"])) + $this->request_realm=$arguments["AuthRealm"]; + elseif(IsSet($this->realm)) + $this->request_realm=$this->realm; + if(IsSet($arguments["AuthWorkstation"])) + $this->request_workstation=$arguments["AuthWorkstation"]; + elseif(IsSet($this->workstation)) + $this->request_workstation=$this->workstation; + if(strlen($this->proxy_host_name)==0 + || $connect) + $request_uri=$this->request_uri; + else + { + switch(strtolower($this->protocol)) + { + case "http": + $default_port=80; + break; + case "https": + $default_port=443; + break; + } + $request_uri=strtolower($this->protocol)."://".$this->host_name.(($this->host_port==0 || $this->host_port==$default_port) ? "" : ":".$this->host_port).$this->request_uri; + } + if($this->use_curl) + { + $version=(GetType($v=curl_version())=="array" ? (IsSet($v["version"]) ? $v["version"] : "0.0.0") : (preg_match("/^libcurl\\/([0-9]+\\.[0-9]+\\.[0-9]+)/",$v,$m) ? $m[1] : "0.0.0")); + $curl_version=100000*intval($this->Tokenize($version,"."))+1000*intval($this->Tokenize("."))+intval($this->Tokenize("")); + $protocol_version=($curl_version<713002 ? "1.0" : $this->protocol_version); + } + else + $protocol_version=$this->protocol_version; + $this->request=$this->request_method." ".$request_uri." HTTP/".$protocol_version; + if($body_length + || ($body_length=strlen($this->request_body)) + || !strcmp($this->request_method, 'POST')) + $this->request_headers["Content-Length"]=$body_length; + for($headers=array(),$host_set=0,Reset($this->request_headers),$header=0;$headerrequest_headers);Next($this->request_headers),$header++) + { + $header_name=Key($this->request_headers); + $header_value=$this->request_headers[$header_name]; + if(GetType($header_value)=="array") + { + for(Reset($header_value),$value=0;$valuerequest_headers))=="host") + { + $this->request_host=strtolower($header_value); + $host_set=1; + } + } + if(!$host_set) + { + $headers[]="Host: ".$this->host_name; + $this->request_host=strtolower($this->host_name); + } + if(count($this->cookies)) + { + $cookies=array(); + $this->PickCookies($cookies,0); + if(strtolower($this->protocol)=="https") + $this->PickCookies($cookies,1); + if(count($cookies)) + { + $h=count($headers); + $headers[$h]="Cookie:"; + for(Reset($cookies),$cookie=0;$cookieuse_curl) + { + if(IsSet($arguments['StreamRequest'])) + return($this->SetError("Streaming request data is not supported when using Curl", HTTP_CLIENT_ERROR_INVALID_PARAMETERS)); + if($body_length + && strlen($this->request_body)==0) + { + for($request_body="",$success=1,$part=0;$partSetPHPError("could not open upload file ".$post_parts[$part]["FILENAME"], $php_errormsg, HTTP_CLIENT_ERROR_CANNOT_ACCESS_LOCAL_FILE); + $success=0; + break; + } + while(!feof($file)) + { + if(GetType($block=@fread($file,$this->file_buffer_length))!="string") + { + $this->SetPHPError("could not read upload file", $php_errormsg, HTTP_CLIENT_ERROR_CANNOT_ACCESS_LOCAL_FILE); + $success=0; + break; + } + $request_body.=$block; + } + fclose($file); + if(!$success) + break; + } + $request_body.="\r\n"; + } + $request_body.="--".$boundary."--\r\n"; + } + else + $request_body=$this->request_body; + curl_setopt($this->connection,CURLOPT_HEADER,1); + curl_setopt($this->connection,CURLOPT_RETURNTRANSFER,1); + if($this->timeout) + curl_setopt($this->connection,CURLOPT_TIMEOUT,$this->timeout); + curl_setopt($this->connection,CURLOPT_SSL_VERIFYPEER,0); + curl_setopt($this->connection,CURLOPT_SSL_VERIFYHOST,0); + $request=$this->request."\r\n".implode("\r\n",$headers)."\r\n\r\n".$request_body; + curl_setopt($this->connection,CURLOPT_CUSTOMREQUEST,$request); + if($this->debug) + $this->OutputDebug("C ".$request); + if(!($success=(strlen($this->response=curl_exec($this->connection))!=0))) + { + $error=curl_error($this->connection); + $this->SetError("Could not execute the request".(strlen($error) ? ": ".$error : ""), HTTP_CLIENT_ERROR_PROTOCOL_FAILURE); + } + } + else + { + if(($success=$this->PutLine($this->request))) + { + for($header=0;$headerPutLine($headers[$header])) + break; + } + if($success + && ($success=$this->PutLine(""))) + { + if(IsSet($arguments['StreamRequest'])) + $next_state = "SendingRequestBody"; + elseif($body_length) + { + if(strlen($this->request_body)) + $success=$this->PutData($this->request_body); + else + { + for($part=0;$partPutData($post_parts[$part]["HEADERS"])) + || !($success=$this->PutData($post_parts[$part]["DATA"]))) + break; + if(IsSet($post_parts[$part]["FILENAME"])) + { + if(!($file=@fopen($post_parts[$part]["FILENAME"],"rb"))) + { + $this->SetPHPError("could not open upload file ".$post_parts[$part]["FILENAME"], $php_errormsg, HTTP_CLIENT_ERROR_CANNOT_ACCESS_LOCAL_FILE); + $success=0; + break; + } + while(!feof($file)) + { + if(GetType($block=@fread($file,$this->file_buffer_length))!="string") + { + $this->SetPHPError("could not read upload file", $php_errormsg, HTTP_CLIENT_ERROR_CANNOT_ACCESS_LOCAL_FILE); + $success=0; + break; + } + if(!($success=$this->PutData($block))) + break; + } + fclose($file); + if(!$success) + break; + } + if(!($success=$this->PutLine(""))) + break; + } + if($success) + $success=$this->PutLine("--".$boundary."--"); + } + if($success) + $sucess=$this->FlushData(); + } + } + } + } + if(!$success) + return($this->SetError("could not send the HTTP request: ".$this->error, $this->error_code)); + $this->state=$next_state; + return(""); + } + + Function SetCookie($name, $value, $expires="" , $path="/" , $domain="" , $secure=0, $verbatim=0) + { + if(strlen($this->error)) + return($this->error); + if(strlen($name)==0) + return($this->SetError("it was not specified a valid cookie name", HTTP_CLIENT_ERROR_INVALID_PARAMETERS)); + if(strlen($path)==0 + || strcmp($path[0],"/")) + return($this->SetError($path." is not a valid path for setting cookie ".$name, HTTP_CLIENT_ERROR_INVALID_PARAMETERS)); + if($domain=="" + || !strpos($domain,".",$domain[0]=="." ? 1 : 0)) + return($this->SetError($domain." is not a valid domain for setting cookie ".$name, HTTP_CLIENT_ERROR_INVALID_PARAMETERS)); + $domain=strtolower($domain); + if(!strcmp($domain[0],".")) + $domain=substr($domain,1); + if(!$verbatim) + { + $name=$this->CookieEncode($name,1); + $value=$this->CookieEncode($value,0); + } + $secure=intval($secure); + $this->cookies[$secure][$domain][$path][$name]=array( + "name"=>$name, + "value"=>$value, + "domain"=>$domain, + "path"=>$path, + "expires"=>$expires, + "secure"=>$secure + ); + return(""); + } + + Function SendRequestBody($data, $end_of_data) + { + if(strlen($this->error)) + return($this->error); + switch($this->state) + { + case "Disconnected": + return($this->SetError("connection was not yet established", HTTP_CLIENT_ERROR_INVALID_PARAMETERS)); + case "Connected": + case "ConnectedToProxy": + return($this->SetError("request was not sent", HTTP_CLIENT_ERROR_INVALID_PARAMETERS)); + case "SendingRequestBody": + break; + case "RequestSent": + return($this->SetError("request body was already sent", HTTP_CLIENT_ERROR_INVALID_PARAMETERS)); + default: + return($this->SetError("can not send the request body in the current connection state", HTTP_CLIENT_ERROR_INVALID_PARAMETERS)); + } + $length = strlen($data); + if($length) + { + $size = dechex($length)."\r\n"; + if(!$this->PutData($size) + || !$this->PutData($data)) + return($this->error); + } + if($end_of_data) + { + $size = "0\r\n"; + if(!$this->PutData($size)) + return($this->error); + $this->state = "RequestSent"; + } + return(""); + } + + Function ReadReplyHeadersResponse(&$headers) + { + $headers=array(); + if(strlen($this->error)) + return($this->error); + switch($this->state) + { + case "Disconnected": + return($this->SetError("connection was not yet established", HTTP_CLIENT_ERROR_INVALID_PARAMETERS)); + case "Connected": + return($this->SetError("request was not sent", HTTP_CLIENT_ERROR_INVALID_PARAMETERS)); + case "ConnectedToProxy": + return($this->SetError("connection from the remote server from the proxy was not yet established", HTTP_CLIENT_ERROR_INVALID_PARAMETERS)); + case "SendingRequestBody": + return($this->SetError("request body data was not completely sent", HTTP_CLIENT_ERROR_INVALID_PARAMETERS)); + case "ConnectSent": + $connect = 1; + break; + case "RequestSent": + $connect = 0; + break; + default: + return($this->SetError("can not get request headers in the current connection state", HTTP_CLIENT_ERROR_INVALID_PARAMETERS)); + } + $this->content_length=$this->read_length=$this->read_response=$this->remaining_chunk=0; + $this->content_length_set=$this->chunked=$this->last_chunk_read=$chunked=0; + $this->force_close = $this->connection_close=0; + for($this->response_status="";;) + { + $line=$this->GetLine(); + if(GetType($line)!="string") + return($this->SetError("could not read request reply: ".$this->error, $this->error_code)); + if(strlen($this->response_status)==0) + { + if(!preg_match($match="/^http\\/[0-9]+\\.[0-9]+[ \t]+([0-9]+)[ \t]*(.*)\$/i",$line,$matches)) + return($this->SetError("it was received an unexpected HTTP response status", HTTP_CLIENT_ERROR_PROTOCOL_FAILURE)); + $this->response_status=$matches[1]; + $this->response_message=$matches[2]; + } + if($line=="") + { + if(strlen($this->response_status)==0) + return($this->SetError("it was not received HTTP response status", HTTP_CLIENT_ERROR_PROTOCOL_FAILURE)); + $this->state=($connect ? "GotConnectHeaders" : "GotReplyHeaders"); + break; + } + $header_name=strtolower($this->Tokenize($line,":")); + $header_value=Trim(Chop($this->Tokenize("\r\n"))); + if(IsSet($headers[$header_name])) + { + if(GetType($headers[$header_name])=="string") + $headers[$header_name]=array($headers[$header_name]); + $headers[$header_name][]=$header_value; + } + else + $headers[$header_name]=$header_value; + if(!$connect) + { + switch($header_name) + { + case "content-length": + $this->content_length=intval($headers[$header_name]); + $this->content_length_set=1; + break; + case "transfer-encoding": + $encoding=$this->Tokenize($header_value,"; \t"); + if(!$this->use_curl + && !strcmp($encoding,"chunked")) + $chunked=1; + break; + case "set-cookie": + if($this->support_cookies) + { + if(GetType($headers[$header_name])=="array") + $cookie_headers=$headers[$header_name]; + else + $cookie_headers=array($headers[$header_name]); + for($cookie=0;$cookieTokenize($cookie_headers[$cookie],"=")); + $cookie_value=$this->Tokenize(";"); + $domain=$this->request_host; + $path="/"; + $expires=""; + $secure=0; + while(($name = strtolower(trim(UrlDecode($this->Tokenize("=")))))!="") + { + $value=UrlDecode($this->Tokenize(";")); + switch($name) + { + case "domain": + $domain=$value; + break; + case "path": + $path=$value; + break; + case "expires": + if(preg_match("/^((Mon|Monday|Tue|Tuesday|Wed|Wednesday|Thu|Thursday|Fri|Friday|Sat|Saturday|Sun|Sunday), )?([0-9]{2})\\-(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\\-([0-9]{2,4}) ([0-9]{2})\\:([0-9]{2})\\:([0-9]{2}) GMT\$/",$value,$matches)) + { + $year=intval($matches[5]); + if($year<1900) + $year+=($year<70 ? 2000 : 1900); + $expires="$year-".$this->months[$matches[4]]."-".$matches[3]." ".$matches[6].":".$matches[7].":".$matches[8]; + } + break; + case "secure": + $secure=1; + break; + } + } + if(strlen($this->SetCookie($cookie_name, $cookie_value, $expires, $path , $domain, $secure, 1))) + $this->error=""; + } + } + break; + case "connection": + $this->force_close = $this->connection_close=!strcmp(strtolower($header_value),"close"); + break; + } + } + } + $this->chunked=$chunked; + if($this->content_length_set) + $this->connection_close=0; + return(""); + } + + Function Redirect(&$headers) + { + if($this->follow_redirect) + { + if(!IsSet($headers["location"]) + || (GetType($headers["location"])!="array" + && strlen($location=$headers["location"])==0) + || (GetType($headers["location"])=="array" + && strlen($location=$headers["location"][0])==0)) + return($this->SetError("it was received a redirect without location URL", HTTP_CLIENT_ERROR_PROTOCOL_FAILURE)); + if(strcmp($location[0],"/")) + { + if(!($location_arguments=@parse_url($location))) + return($this->SetError("the server did not return a valid redirection location URL", HTTP_CLIENT_ERROR_PROTOCOL_FAILURE)); + if(!IsSet($location_arguments["scheme"])) + $location=((GetType($end=strrpos($this->request_uri,"/"))=="integer" && $end>1) ? substr($this->request_uri,0,$end) : "")."/".$location; + } + if(!strcmp($location[0],"/")) + $location=$this->protocol."://".$this->host_name.($this->host_port ? ":".$this->host_port : "").$location; + $error=$this->GetRequestArguments($location,$arguments); + if(strlen($error)) + return($this->SetError("could not process redirect url: ".$error, HTTP_CLIENT_ERROR_PROTOCOL_FAILURE)); + $arguments["RequestMethod"]="GET"; + if(strlen($error=$this->Close())==0 + && strlen($error=$this->Open($arguments))==0 + && strlen($error=$this->SendRequest($arguments))==0) + { + $this->redirection_level++; + if($this->redirection_level>$this->redirection_limit) + { + $error="it was exceeded the limit of request redirections"; + $this->error_code = HTTP_CLIENT_ERROR_PROTOCOL_FAILURE; + } + else + $error=$this->ReadReplyHeaders($headers); + $this->redirection_level--; + } + if(strlen($error)) + return($this->SetError($error, $this->error_code)); + } + return(""); + } + + Function Authenticate(&$headers, $proxy, &$proxy_authorization, &$user, &$password, &$realm, &$workstation) + { + if($proxy) + { + $authenticate_header="proxy-authenticate"; + $authorization_header="Proxy-Authorization"; + $authenticate_status="407"; + $authentication_mechanism=$this->proxy_authentication_mechanism; + } + else + { + $authenticate_header="www-authenticate"; + $authorization_header="Authorization"; + $authenticate_status="401"; + $authentication_mechanism=$this->authentication_mechanism; + } + if(IsSet($headers[$authenticate_header]) + && $this->sasl_authenticate) + { + if(function_exists("class_exists") + && !class_exists("sasl_client_class")) + return($this->SetError("the SASL client class needs to be loaded to be able to authenticate".($proxy ? " with the proxy server" : "")." and access this site", HTTP_CLIENT_ERROR_INVALID_PARAMETERS)); + if(GetType($headers[$authenticate_header])=="array") + $authenticate=$headers[$authenticate_header]; + else + $authenticate=array($headers[$authenticate_header]); + for($response="", $mechanisms=array(),$m=0;$mTokenize($authenticate[$m]," "); + $response=$this->Tokenize(""); + if(strlen($authentication_mechanism)) + { + if(!strcmp($authentication_mechanism,$mechanism)) + { + $mechanisms[]=$mechanism; + break; + } + } + else + $mechanisms[]=$mechanism; + } + $sasl=new sasl_client_class; + if(IsSet($user)) + $sasl->SetCredential("user",$user); + if(IsSet($password)) + $sasl->SetCredential("password",$password); + if(IsSet($realm)) + $sasl->SetCredential("realm",$realm); + if(IsSet($workstation)) + $sasl->SetCredential("workstation",$workstation); + $sasl->SetCredential("uri",$this->request_uri); + $sasl->SetCredential("method",$this->request_method); + $sasl->SetCredential("session",$this->session); + do + { + $status=$sasl->Start($mechanisms,$message,$interactions); + } + while($status==SASL_INTERACT); + switch($status) + { + case SASL_CONTINUE: + break; + case SASL_NOMECH: + return($this->SetError(($proxy ? "proxy " : "")."authentication error: ".(strlen($authentication_mechanism) ? "authentication mechanism ".$authentication_mechanism." may not be used: " : "").$sasl->error, HTTP_CLIENT_ERROR_INVALID_PARAMETERS)); + default: + return($this->SetError("Could not start the SASL ".($proxy ? "proxy " : "")."authentication client: ".$sasl->error, HTTP_CLIENT_ERROR_INVALID_PARAMETERS)); + } + if($proxy >= 0) + { + for(;;) + { + if(strlen($error=$this->ReadReplyBody($body,$this->file_buffer_length))) + return($error); + if(strlen($body)==0) + break; + } + } + $authorization_value=$sasl->mechanism.(IsSet($message) ? " ".($sasl->encode_response ? base64_encode($message) : $message) : ""); + $request_arguments=$this->request_arguments; + $arguments=$request_arguments; + $arguments["Headers"][$authorization_header]=$authorization_value; + if(!$proxy + && strlen($proxy_authorization)) + $arguments["Headers"]["Proxy-Authorization"]=$proxy_authorization; + if(strlen($error=$this->Close()) + || strlen($error=$this->Open($arguments))) + return($this->SetError($error, $this->error_code)); + $authenticated=0; + if(IsSet($message)) + { + if($proxy < 0) + { + if(strlen($error=$this->ConnectFromProxy($arguments, $headers))) + return($this->SetError($error, $this->error_code)); + } + else + { + if(strlen($error=$this->SendRequest($arguments)) + || strlen($error=$this->ReadReplyHeadersResponse($headers))) + return($this->SetError($error, $this->error_code)); + } + if(!IsSet($headers[$authenticate_header])) + $authenticate=array(); + elseif(GetType($headers[$authenticate_header])=="array") + $authenticate=$headers[$authenticate_header]; + else + $authenticate=array($headers[$authenticate_header]); + for($mechanism=0;$mechanismTokenize($authenticate[$mechanism]," "),$sasl->mechanism)) + { + $response=$this->Tokenize(""); + break; + } + } + switch($this->response_status) + { + case $authenticate_status: + break; + case "301": + case "302": + case "303": + case "307": + if($proxy >= 0) + return($this->Redirect($headers)); + default: + if(intval($this->response_status/100)==2) + { + if($proxy) + $proxy_authorization=$authorization_value; + $authenticated=1; + break; + } + if($proxy + && !strcmp($this->response_status,"401")) + { + $proxy_authorization=$authorization_value; + $authenticated=1; + break; + } + return($this->SetError(($proxy ? "proxy " : "")."authentication error: ".$this->response_status." ".$this->response_message, HTTP_CLIENT_ERROR_PROTOCOL_FAILURE)); + } + } + for(;!$authenticated;) + { + do + { + $status=$sasl->Step($response,$message,$interactions); + } + while($status==SASL_INTERACT); + switch($status) + { + case SASL_CONTINUE: + $authorization_value=$sasl->mechanism.(IsSet($message) ? " ".($sasl->encode_response ? base64_encode($message) : $message) : ""); + $arguments=$request_arguments; + $arguments["Headers"][$authorization_header]=$authorization_value; + if(!$proxy + && strlen($proxy_authorization)) + $arguments["Headers"]["Proxy-Authorization"]=$proxy_authorization; + if($proxy < 0) + { + if(strlen($error=$this->ConnectFromProxy($arguments, $headers))) + return($this->SetError($error, $this->error_code)); + } + else + { + if(strlen($error=$this->SendRequest($arguments)) + || strlen($error=$this->ReadReplyHeadersResponse($headers))) + return($this->SetError($error, $this->error_code)); + } + switch($this->response_status) + { + case $authenticate_status: + if(GetType($headers[$authenticate_header])=="array") + $authenticate=$headers[$authenticate_header]; + else + $authenticate=array($headers[$authenticate_header]); + for($response="",$mechanism=0;$mechanismTokenize($authenticate[$mechanism]," "),$sasl->mechanism)) + { + $response=$this->Tokenize(""); + break; + } + } + if($proxy >= 0) + { + for(;;) + { + if(strlen($error=$this->ReadReplyBody($body,$this->file_buffer_length))) + return($error); + if(strlen($body)==0) + break; + } + } + $this->state="Connected"; + break; + case "301": + case "302": + case "303": + case "307": + if($proxy >= 0) + return($this->Redirect($headers)); + default: + if(intval($this->response_status/100)==2) + { + if($proxy) + $proxy_authorization=$authorization_value; + $authenticated=1; + break; + } + if($proxy + && !strcmp($this->response_status,"401")) + { + $proxy_authorization=$authorization_value; + $authenticated=1; + break; + } + return($this->SetError(($proxy ? "proxy " : "")."authentication error: ".$this->response_status." ".$this->response_message)); + } + break; + default: + return($this->SetError("Could not process the SASL ".($proxy ? "proxy " : "")."authentication step: ".$sasl->error, HTTP_CLIENT_ERROR_PROTOCOL_FAILURE)); + } + } + } + return(""); + } + + Function ReadReplyHeaders(&$headers) + { + if(strlen($error=$this->ReadReplyHeadersResponse($headers))) + return($error); + $proxy_authorization=""; + while(!strcmp($this->response_status, "100")) + { + $this->state="RequestSent"; + if(strlen($error=$this->ReadReplyHeadersResponse($headers))) + return($error); + } + switch($this->response_status) + { + case "301": + case "302": + case "303": + case "307": + if(strlen($error=$this->Redirect($headers))) + return($error); + break; + case "407": + if(strlen($error=$this->Authenticate($headers, 1, $proxy_authorization, $this->proxy_request_user, $this->proxy_request_password, $this->proxy_request_realm, $this->proxy_request_workstation))) + return($error); + if(strcmp($this->response_status,"401")) + return(""); + case "401": + return($this->Authenticate($headers, 0, $proxy_authorization, $this->request_user, $this->request_password, $this->request_realm, $this->request_workstation)); + } + return(""); + } + + Function ReadReplyBody(&$body,$length) + { + $body=""; + if(strlen($this->error)) + return($this->error); + switch($this->state) + { + case "Disconnected": + return($this->SetError("connection was not yet established", HTTP_CLIENT_ERROR_INVALID_PARAMETERS)); + case "Connected": + case "ConnectedToProxy": + return($this->SetError("request was not sent", HTTP_CLIENT_ERROR_INVALID_PARAMETERS)); + case "RequestSent": + if(($error=$this->ReadReplyHeaders($headers))!="") + return($error); + break; + case "GotReplyHeaders": + break; + case 'ResponseReceived': + $body = ''; + return(''); + default: + return($this->SetError("can not get request headers in the current connection state", HTTP_CLIENT_ERROR_INVALID_PARAMETERS)); + } + if($this->content_length_set) + $length=min($this->content_length-$this->read_length,$length); + $body = ''; + if($length>0) + { + if(!$this->EndOfInput() + && ($body=$this->ReadBytes($length))=="") + { + if(strlen($this->error)) + return($this->SetError("could not get the request reply body: ".$this->error, $this->error_code)); + } + $this->read_length+=strlen($body); + if($this->EndOfInput()) + $this->state = 'ResponseReceived'; + } + return(""); + } + + Function ReadWholeReplyBody(&$body) + { + $body = ''; + for(;;) + { + if(strlen($error = $this->ReadReplyBody($block, $this->file_buffer_length))) + return($error); + if(strlen($block) == 0) + return(''); + $body .= $block; + } + } + + Function SaveCookies(&$cookies, $domain='', $secure_only=0, $persistent_only=0) + { + $now=gmdate("Y-m-d H-i-s"); + $cookies=array(); + for($secure_cookies=0,Reset($this->cookies);$secure_cookiescookies);Next($this->cookies),$secure_cookies++) + { + $secure=Key($this->cookies); + if(!$secure_only + || $secure) + { + for($cookie_domain=0,Reset($this->cookies[$secure]);$cookie_domaincookies[$secure]);Next($this->cookies[$secure]),$cookie_domain++) + { + $domain_pattern=Key($this->cookies[$secure]); + $match=strlen($domain)-strlen($domain_pattern); + if(strlen($domain)==0 + || ($match>=0 + && !strcmp($domain_pattern,substr($domain,$match)) + && ($match==0 + || $domain_pattern[0]=="." + || $domain[$match-1]=="."))) + { + for(Reset($this->cookies[$secure][$domain_pattern]),$path_part=0;$path_partcookies[$secure][$domain_pattern]);Next($this->cookies[$secure][$domain_pattern]),$path_part++) + { + $path=Key($this->cookies[$secure][$domain_pattern]); + for(Reset($this->cookies[$secure][$domain_pattern][$path]),$cookie=0;$cookiecookies[$secure][$domain_pattern][$path]);Next($this->cookies[$secure][$domain_pattern][$path]),$cookie++) + { + $cookie_name=Key($this->cookies[$secure][$domain_pattern][$path]); + $expires=$this->cookies[$secure][$domain_pattern][$path][$cookie_name]["expires"]; + if((!$persistent_only + && strlen($expires)==0) + || (strlen($expires) + && strcmp($now,$expires)<0)) + $cookies[$secure][$domain_pattern][$path][$cookie_name]=$this->cookies[$secure][$domain_pattern][$path][$cookie_name]; + } + } + } + } + } + } + } + + Function SavePersistentCookies(&$cookies, $domain='', $secure_only=0) + { + $this->SaveCookies($cookies, $domain, $secure_only, 1); + } + + Function GetPersistentCookies(&$cookies, $domain='', $secure_only=0) + { + $this->SavePersistentCookies($cookies, $domain, $secure_only); + } + + Function RestoreCookies($cookies, $clear=1) + { + $new_cookies=($clear ? array() : $this->cookies); + for($secure_cookies=0, Reset($cookies); $secure_cookiesSetError("invalid cookie secure value type (".serialize($secure).")", HTTP_CLIENT_ERROR_INVALID_PARAMETERS)); + for($cookie_domain=0,Reset($cookies[$secure]);$cookie_domainSetError("invalid cookie domain value type (".serialize($domain_pattern).")", HTTP_CLIENT_ERROR_INVALID_PARAMETERS)); + for(Reset($cookies[$secure][$domain_pattern]),$path_part=0;$path_partSetError("invalid cookie path value type (".serialize($path).")", HTTP_CLIENT_ERROR_INVALID_PARAMETERS)); + for(Reset($cookies[$secure][$domain_pattern][$path]),$cookie=0;$cookieSetError("invalid cookie expiry value type (".serialize($expires).")", HTTP_CLIENT_ERROR_INVALID_PARAMETERS)); + $new_cookies[$secure][$domain_pattern][$path][$cookie_name]=array( + "name"=>$cookie_name, + "value"=>$value, + "domain"=>$domain_pattern, + "path"=>$path, + "expires"=>$expires, + "secure"=>$secure + ); + } + } + } + } + $this->cookies=$new_cookies; + return(""); + } +}; + +?> \ No newline at end of file diff --git a/library/oauth/oauth_client.php b/library/oauth/oauth_client.php new file mode 100644 index 000000000..5047e0e9b --- /dev/null +++ b/library/oauth/oauth_client.php @@ -0,0 +1,2176 @@ + + + + net.manuellemos.oauth + + @(#) $Id: oauth_client.php,v 1.58 2013/04/11 09:33:16 mlemos Exp $ + Copyright © (C) Manuel Lemos 2012 + OAuth client + Manuel Lemos + mlemos-at-acm.org + + + en + This class serves two main purposes: + 1) Implement the OAuth protocol to retrieve a token from a server to + authorize the access to an API on behalf of the current + user. + 2) Perform calls to a Web services API using a token previously + obtained using this class or a token provided some other way by the + Web services provider. + Regardless of your purposes, you always need to start calling + the class Initialize function after + initializing setup variables. After you are done with the class, + always call the Finalize function at + the end. + This class supports either OAuth protocol versions 1.0, 1.0a and + 2.0. It abstracts the differences between these protocol versions, + so the class usage is the same independently of the OAuth + version of the server. + The class also provides built-in support to several popular OAuth + servers, so you do not have to manually configure all the details to + access those servers. Just set the + server variable to configure the class + to access one of the built-in supported servers. + If you need to access one type of server that is not yet directly + supported by the class, you need to configure it explicitly setting + the variables: oauth_version, + url_parameters, + authorization_header, + request_token_url, + dialog_url, + offline_dialog_url, + append_state_to_redirect_uri and + access_token_url. + Before proceeding to the actual OAuth authorization process, you + need to have registered your application with the OAuth server. The + registration provides you values to set the variables + client_id and + client_secret. + You also need to set the variables + redirect_uri and + scope before calling the + Process function to make the class + perform the necessary interactions with the OAuth + server. + The OAuth protocol involves multiple steps that include redirection + to the OAuth server. There it asks permission to the current user to + grant your application access to APIs on his/her behalf. When there + is a redirection, the class will set the + exit variable to + 1. Then your script should exit + immediately without outputting anything. + When the OAuth access token is successfully obtained, the following + variables are set by the class with the obtained values: + access_token, + access_token_secret, + access_token_expiry, + access_token_type. You may want to + store these values to use them later when calling the server + APIs. + If there was a problem during OAuth authorization process, check the + variable authorization_error to + determine the reason. + Once you get the access token, you can call the server APIs using + the CallAPI function. Check the + access_token_error variable to + determine if there was an error when trying to to call the + API. + If for some reason the user has revoked the access to your + application, you need to ask the user to authorize your application + again. First you may need to call the function + ResetAccessToken to reset the value of + the access token that may be cached in session variables. + + +{/metadocument} +*/ + +class oauth_client_class +{ +/* +{metadocument} + + error + STRING + + + Store the message that is returned when an error + occurs. + Check this variable to understand what happened when a call to + any of the class functions has failed. + This class uses cumulative error handling. This means that if one + class functions that may fail is called and this variable was + already set to an error message due to a failure in a previous call + to the same or other function, the function will also fail and does + not do anything. + This allows programs using this class to safely call several + functions that may fail and only check the failure condition after + the last function call. + Just set this variable to an empty string to clear the error + condition. + + +{/metadocument} +*/ + var $error = ''; + +/* +{metadocument} + + debug + BOOLEAN + 0 + + Control whether debug output is enabled + Set this variable to 1 if you + need to check what is going on during calls to the class. When + enabled, the debug output goes either to the variable + debug_output and the PHP error log. + + +{/metadocument} +*/ + var $debug = false; + +/* +{metadocument} + + debug_http + BOOLEAN + 0 + + Control whether the dialog with the remote Web server + should also be logged. + Set this variable to 1 if you + want to inspect the data exchange with the OAuth server. + + +{/metadocument} +*/ + var $debug_http = false; + +/* +{metadocument} + + exit + BOOLEAN + 0 + + Determine if the current script should be exited. + Check this variable after calling the + Process function and exit your script + immediately if the variable is set to + 1. + + +{/metadocument} +*/ + var $exit = false; + +/* +{metadocument} + + debug_output + STRING + + + Capture the debug output generated by the class + Inspect this variable if you need to see what happened during + the class function calls. + + +{/metadocument} +*/ + var $debug_output = ''; + +/* +{metadocument} + + debug_prefix + STRING + OAuth client: + + Mark the lines of the debug output to identify actions + performed by this class. + Change this variable if you prefer the debug output lines to + be prefixed with a different text. + + +{/metadocument} +*/ + var $debug_prefix = 'OAuth client: '; + +/* +{metadocument} + + server + STRING + + + Identify the type of OAuth server to access. + The class provides built-in support to several types of OAuth + servers. This means that the class can automatically initialize + several configuration variables just by setting this server + variable. + Currently it supports the following servers: + Bitbucket, + Box, + Dropbox, + Eventful, + Facebook, + Fitbit, + Flickr, + Foursquare, + github, + Google, + Instagram, + LinkedIn, + Microsoft, + Scoop.it, + StockTwits, + Tumblr, + Twitter, + XING and + Yahoo. Please contact the author if you + would like to ask to add built-in support for other types of OAuth + servers. + If you want to access other types of OAuth servers that are not + yet supported, set this variable to an empty string and configure + other variables with values specific to those servers. + + +{/metadocument} +*/ + var $server = ''; + +/* +{metadocument} + + request_token_url + STRING + + + URL of the OAuth server to request the initial token for + OAuth 1.0 and 1.0a servers. + Set this variable to the OAuth request token URL when you are + not accessing one of the built-in supported OAuth + servers. + For OAuth 1.0 and 1.0a servers, the request token URL can have + certain marks that will act as template placeholders which will be + replaced with given values before requesting the authorization + token. Currently it supports the following placeholder + marks: + {SCOPE} - scope of the requested permissions to the granted by the + OAuth server with the user permissions + + +{/metadocument} +*/ + var $request_token_url = ''; + +/* +{metadocument} + + dialog_url + STRING + + + URL of the OAuth server to redirect the browser so the user + can grant access to your application. + Set this variable to the OAuth request token URL when you are + not accessing one of the built-in supported OAuth servers. + For certain servers, the dialog URL can have certain marks that + will act as template placeholders which will be replaced with + values defined before redirecting the users browser. Currently it + supports the following placeholder marks: + {REDIRECT_URI} - URL to redirect when returning from the OAuth + server authorization page + {CLIENT_ID} - client application identifier registered at the + server + {SCOPE} - scope of the requested permissions to the granted by the + OAuth server with the user permissions + {STATE} - identifier of the OAuth session state + + +{/metadocument} +*/ + var $dialog_url = ''; + +/* +{metadocument} + + offline_dialog_url + STRING + + + URL of the OAuth server to redirect the browser so the user + can grant access to your application when offline access is + requested. + Set this variable to the OAuth request token URL when you are + not accessing one of the built-in supported OAuth servers and the + OAuth server supports offline access. + It should have the same format as the + dialog_url variable. + + +{/metadocument} +*/ + var $offline_dialog_url = ''; + +/* +{metadocument} + + append_state_to_redirect_uri + STRING + + + Pass the OAuth session state in a variable with a different + name to work around implementation bugs of certain OAuth + servers + Set this variable when you are not accessing one of the + built-in supported OAuth servers if the OAuth server has a bug + that makes it not pass back the OAuth state identifier in a + request variable named state. + + +{/metadocument} +*/ + var $append_state_to_redirect_uri = ''; + +/* +{metadocument} + + access_token_url + STRING + + + OAuth server URL that will return the access token + URL. + Set this variable to the OAuth access token URL when you are + not accessing one of the built-in supported OAuth servers. + + +{/metadocument} +*/ + var $access_token_url = ''; + + +/* +{metadocument} + + oauth_version + STRING + 2.0 + + Version of the protocol version supported by the OAuth + server. + Set this variable to the OAuth server protocol version when + you are not accessing one of the built-in supported OAuth + servers. + + +{/metadocument} +*/ + var $oauth_version = '2.0'; + +/* +{metadocument} + + url_parameters + BOOLEAN + 0 + + Determine if the API call parameters should be moved to the + call URL. + Set this variable to 1 if the + API you need to call requires that the call parameters always be + passed via the API URL. + + +{/metadocument} +*/ + var $url_parameters = false; + +/* +{metadocument} + + authorization_header + BOOLEAN + 1 + + Determine if the OAuth parameters should be passed via HTTP + Authorization request header. + Set this variable to 1 if the + OAuth server requires that the OAuth parameters be passed using + the HTTP Authorization instead of the request URI parameters. + + +{/metadocument} +*/ + var $authorization_header = true; + +/* +{metadocument} + + token_request_method + STRING + GET + + Define the HTTP method that should be used to request + tokens from the server. + Set this variable to POST if the + OAuth server does not support requesting tokens using the HTTP GET + method. + + +{/metadocument} +*/ + var $token_request_method = 'GET'; + +/* +{metadocument} + + signature_method + STRING + HMAC-SHA1 + + Define the method to generate the signature for API request + parameters values. + Currently it supports PLAINTEXT + and HMAC-SHA1. + + +{/metadocument} +*/ + var $signature_method = 'HMAC-SHA1'; + +/* +{metadocument} + + redirect_uri + STRING + + + URL of the current script page that is calling this + class + Set this variable to the current script page URL before + proceeding the the OAuth authorization process. + + +{/metadocument} +*/ + var $redirect_uri = ''; + +/* +{metadocument} + + client_id + STRING + + + Identifier of your application registered with the OAuth + server + Set this variable to the application identifier that is + provided by the OAuth server when you register the + application. + + +{/metadocument} +*/ + var $client_id = ''; + +/* +{metadocument} + + client_secret + STRING + + + Secret value assigned to your application when it is + registered with the OAuth server. + Set this variable to the application secret that is provided + by the OAuth server when you register the application. + + +{/metadocument} +*/ + var $client_secret = ''; + +/* +{metadocument} + + scope + STRING + + + Permissions that your application needs to call the OAuth + server APIs + Check the documentation of the APIs that your application + needs to call to set this variable with the identifiers of the + permissions that the user needs to grant to your application. + + +{/metadocument} +*/ + var $scope = ''; + +/* +{metadocument} + + offline + BOOLEAN + 0 + + Specify whether it will be necessary to call the API when + the user is not present and the server supports renewing expired + access tokens using refresh tokens. + Set this variable to 1 if the + server supports renewing expired tokens automatically when the + user is not present. + + +{/metadocument} +*/ + var $offline = false; + +/* +{metadocument} + + access_token + STRING + + + Access token obtained from the OAuth server + Check this variable to get the obtained access token upon + successful OAuth authorization. + + +{/metadocument} +*/ + var $access_token = ''; + +/* +{metadocument} + + access_token_secret + STRING + + + Access token secret obtained from the OAuth server + If the OAuth protocol version is 1.0 or 1.0a, check this + variable to get the obtained access token secret upon successful + OAuth authorization. + + +{/metadocument} +*/ + var $access_token_secret = ''; + +/* +{metadocument} + + access_token_expiry + STRING + + + Timestamp of the expiry of the access token obtained from + the OAuth server. + Check this variable to get the obtained access token expiry + time upon successful OAuth authorization. If this variable is + empty, that means no expiry time was set. + + +{/metadocument} +*/ + var $access_token_expiry = ''; + +/* +{metadocument} + + access_token_type + STRING + + + Type of access token obtained from the OAuth server. + Check this variable to get the obtained access token type + upon successful OAuth authorization. + + +{/metadocument} +*/ + var $access_token_type = ''; + +/* +{metadocument} + + refresh_token + STRING + + + Refresh token obtained from the OAuth server + Check this variable to get the obtained refresh token upon + successful OAuth authorization. + + +{/metadocument} +*/ + var $refresh_token = ''; + +/* +{metadocument} + + access_token_error + STRING + + + Error message returned when a call to the API fails. + Check this variable to determine if there was an error while + calling the Web services API when using the + CallAPI function. + + +{/metadocument} +*/ + var $access_token_error = ''; + +/* +{metadocument} + + authorization_error + STRING + + + Error message returned when it was not possible to obtain + an OAuth access token + Check this variable to determine if there was an error while + trying to obtain the OAuth access token. + + +{/metadocument} +*/ + var $authorization_error = ''; + +/* +{metadocument} + + response_status + INTEGER + 0 + + HTTP response status returned by the server when calling an + API + Check this variable after calling the + CallAPI function if the API calls and you + need to process the error depending the response status. + 200 means no error. + 0 means the server response was not + retrieved. + + +{/metadocument} +*/ + var $response_status = 0; + + var $oauth_user_agent = 'PHP-OAuth-API (http://www.phpclasses.org/oauth-api $Revision: 1.58 $)'; + var $session_started = false; + + Function SetError($error) + { + $this->error = $error; + if($this->debug) + $this->OutputDebug('Error: '.$error); + return(false); + } + + Function SetPHPError($error, &$php_error_message) + { + if(IsSet($php_error_message) + && strlen($php_error_message)) + $error.=": ".$php_error_message; + return($this->SetError($error)); + } + + Function OutputDebug($message) + { + if($this->debug) + { + $message = $this->debug_prefix.$message; + $this->debug_output .= $message."\n";; + error_log($message); + } + return(true); + } + + Function GetRequestTokenURL(&$request_token_url) + { + $request_token_url = $this->request_token_url; + return(true); + } + + Function GetDialogURL(&$url, $redirect_uri = '', $state = '') + { + $url = (($this->offline && strlen($this->offline_dialog_url)) ? $this->offline_dialog_url : $this->dialog_url); + if(strlen($url) === 0) + return $this->SetError('the dialog URL '.($this->offline ? 'for offline access ' : '').'is not defined for this server'); + $url = str_replace( + '{REDIRECT_URI}', UrlEncode($redirect_uri), str_replace( + '{STATE}', UrlEncode($state), str_replace( + '{CLIENT_ID}', UrlEncode($this->client_id), str_replace( + '{SCOPE}', UrlEncode($this->scope), + $url)))); + return(true); + } + + Function GetAccessTokenURL(&$access_token_url) + { + $access_token_url = $this->access_token_url; + return(true); + } + + Function GetStoredState(&$state) + { + if(!$this->session_started) + { + if(!function_exists('session_start')) + return $this->SetError('Session variables are not accessible in this PHP environment'); + } + if(IsSet($_SESSION['OAUTH_STATE'])) + $state = $_SESSION['OAUTH_STATE']; + else + $state = $_SESSION['OAUTH_STATE'] = time().'-'.substr(md5(rand().time()), 0, 6); + return(true); + } + + Function GetRequestState(&$state) + { + $check = (strlen($this->append_state_to_redirect_uri) ? $this->append_state_to_redirect_uri : 'state'); + $state = (IsSet($_GET[$check]) ? $_GET[$check] : null); + return(true); + } + + Function GetRequestCode(&$code) + { + $code = (IsSet($_GET['code']) ? $_GET['code'] : null); + return(true); + } + + Function GetRequestError(&$error) + { + $error = (IsSet($_GET['error']) ? $_GET['error'] : null); + return(true); + } + + Function GetRequestDenied(&$denied) + { + $denied = (IsSet($_GET['denied']) ? $_GET['denied'] : null); + return(true); + } + + Function GetRequestToken(&$token, &$verifier) + { + $token = (IsSet($_GET['oauth_token']) ? $_GET['oauth_token'] : null); + $verifier = (IsSet($_GET['oauth_verifier']) ? $_GET['oauth_verifier'] : null); + return(true); + } + + Function GetRedirectURI(&$redirect_uri) + { + if(strlen($this->redirect_uri)) + $redirect_uri = $this->redirect_uri; + else + $redirect_uri = 'http://'.$_SERVER['HTTP_HOST'].$_SERVER['REQUEST_URI']; + return true; + } + +/* +{metadocument} + + StoreAccessToken + BOOLEAN + + Store the values of the access token when it is succefully + retrieved from the OAuth server. + This function is meant to be only be called from inside the + class. By default it stores access tokens in a session variable + named OAUTH_ACCESS_TOKEN. + Actual implementations should create a sub-class and override this + function to make the access token values be stored in other types + of containers, like for instance databases. + This function should return + 1 if the access token was stored + successfully. + + + access_token + HASH + + Associative array with properties of the access token. + The array may have set the following + properties: + value: string value of the access + token + authorized: boolean value that + determines if the access token was obtained + successfully + expiry: (optional) timestamp in ISO + format relative to UTC time zone of the access token expiry + time + type: (optional) type of OAuth token + that may determine how it should be used when sending API call + requests. + refresh: (optional) token that some + servers may set to allowing refreshing access tokens when they + expire. + + + +{/metadocument} +*/ + Function StoreAccessToken($access_token) + { + if(!$this->session_started) + { + if(!function_exists('session_start')) + return $this->SetError('Session variables are not accessible in this PHP environment'); + } + $_SESSION['OAUTH_ACCESS_TOKEN'][$this->access_token_url] = $access_token; + return true; + } +/* +{metadocument} + + +{/metadocument} +*/ + +/* +{metadocument} + + GetAccessToken + BOOLEAN + + Retrieve the OAuth access token if it was already + previously stored by the + StoreAccessToken function. + This function is meant to be only be called from inside the + class. By default it retrieves access tokens stored in a session + variable named + OAUTH_ACCESS_TOKEN. + Actual implementations should create a sub-class and override this + function to retrieve the access token values from other types of + containers, like for instance databases. + This function should return + 1 if the access token was retrieved + successfully. + + + access_token + STRING + + + Return the properties of the access token in an + associative array. If the access token was not yet stored, it + returns an empty array. Otherwise, the properties it may return + are the same that may be passed to the + StoreAccessToken. + + + +{/metadocument} +*/ + Function GetAccessToken(&$access_token) + { + if(!$this->session_started) + { + if(!function_exists('session_start')) + return $this->SetError('Session variables are not accessible in this PHP environment'); + if(!session_start()) + return($this->SetPHPError('it was not possible to start the PHP session', $php_error_message)); + $this->session_started = true; + } + if(IsSet($_SESSION['OAUTH_ACCESS_TOKEN'][$this->access_token_url])) + $access_token = $_SESSION['OAUTH_ACCESS_TOKEN'][$this->access_token_url]; + else + $access_token = array(); + return true; + } +/* +{metadocument} + + +{/metadocument} +*/ + +/* +{metadocument} + + ResetAccessToken + BOOLEAN + + Reset the access token to a state back when the user has + not yet authorized the access to the OAuth server API. + Call this function if for some reason the token to access + the API was revoked and you need to ask the user to authorize + the access again. + By default the class stores and retrieves access tokens in a + session variable named + OAUTH_ACCESS_TOKEN. + This function must be called when the user is accessing your site + pages, so it can reset the information stored in session variables + that cache the state of a previously retrieved access + token. + Actual implementations should create a sub-class and override this + function to reset the access token state when it is stored in + other types of containers, like for instance databases. + This function should return + 1 if the access token was resetted + successfully. + + +{/metadocument} +*/ + Function ResetAccessToken() + { + if($this->debug) + $this->OutputDebug('Resetting the access token status for OAuth server located at '.$this->access_token_url); + if(!$this->session_started) + { + if(!function_exists('session_start')) + return $this->SetError('Session variables are not accessible in this PHP environment'); + if(!session_start()) + return($this->SetPHPError('it was not possible to start the PHP session', $php_error_message)); + } + $this->session_started = true; + if(IsSet($_SESSION['OAUTH_ACCESS_TOKEN'][$this->access_token_url])) + Unset($_SESSION['OAUTH_ACCESS_TOKEN'][$this->access_token_url]); + return true; + } +/* +{metadocument} + + +{/metadocument} +*/ + + Function Encode($value) + { + return(is_array($value) ? $this->EncodeArray($value) : str_replace('%7E', '~', str_replace('+',' ', RawURLEncode($value)))); + } + + Function EncodeArray($array) + { + foreach($array as $key => $value) + $array[$key] = $this->Encode($value); + return $array; + } + + Function HMAC($function, $data, $key) + { + switch($function) + { + case 'sha1': + $pack = 'H40'; + break; + default: + if($this->debug) + $this->OutputDebug($function.' is not a supported an HMAC hash type'); + return(''); + } + if(strlen($key) > 64) + $key = pack($pack, $function($key)); + if(strlen($key) < 64) + $key = str_pad($key, 64, "\0"); + return(pack($pack, $function((str_repeat("\x5c", 64) ^ $key).pack($pack, $function((str_repeat("\x36", 64) ^ $key).$data))))); + } + + Function SendAPIRequest($url, $method, $parameters, $oauth, $options, &$response) + { + $this->response_status = 0; + $http = new http_class; + $http->debug = ($this->debug && $this->debug_http); + $http->log_debug = true; + $http->sasl_authenticate = 0; + $http->user_agent = $this->oauth_user_agent; + $http->redirection_limit = (IsSet($options['FollowRedirection']) ? intval($options['FollowRedirection']) : 0); + $http->follow_redirect = ($http->redirection_limit != 0); + if($this->debug) + $this->OutputDebug('Accessing the '.$options['Resource'].' at '.$url); + $post_files = array(); + $method = strtoupper($method); + $authorization = ''; + $type = (IsSet($options['RequestContentType']) ? strtolower(trim(strtok($options['RequestContentType'], ';'))) : 'application/x-www-form-urlencoded'); + if(IsSet($oauth)) + { + $values = array( + 'oauth_consumer_key'=>$this->client_id, + 'oauth_nonce'=>md5(uniqid(rand(), true)), + 'oauth_signature_method'=>$this->signature_method, + 'oauth_timestamp'=>time(), + 'oauth_version'=>'1.0', + ); + $files = (IsSet($options['Files']) ? $options['Files'] : array()); + if(count($files)) + { + foreach($files as $name => $value) + { + if(!IsSet($parameters[$name])) + return($this->SetError('it was specified an file parameters named '.$name)); + $file = array(); + switch(IsSet($value['Type']) ? $value['Type'] : 'FileName') + { + case 'FileName': + $file['FileName'] = $parameters[$name]; + break; + case 'Data': + $file['Data'] = $parameters[$name]; + break; + default: + return($this->SetError($value['Type'].' is not a valid type for file '.$name)); + } + $file['ContentType'] = (IsSet($value['Content-Type']) ? $value['Content-Type'] : 'automatic/name'); + $post_files[$name] = $file; + } + UnSet($parameters[$name]); + if($method !== 'POST') + { + $this->OutputDebug('For uploading files the method should be POST not '.$method); + $method = 'POST'; + } + if($type !== 'multipart/form-data') + { + if(IsSet($options['RequestContentType'])) + return($this->SetError('the request content type for uploading files should be multipart/form-data')); + $type = 'multipart/form-data'; + } + $value_parameters = array(); + } + else + { + if($this->url_parameters + && $type === 'application/x-www-form-urlencoded' + && count($parameters)) + { + $first = (strpos($url, '?') === false); + foreach($parameters as $parameter => $value) + { + $url .= ($first ? '?' : '&').UrlEncode($parameter).'='.UrlEncode($value); + $first = false; + } + $parameters = array(); + } + $value_parameters = ($type !== 'application/x-www-form-urlencoded' ? array() : $parameters); + } + $values = array_merge($values, $oauth, $value_parameters); + $key = $this->Encode($this->client_secret).'&'.$this->Encode($this->access_token_secret); + switch($this->signature_method) + { + case 'PLAINTEXT': + $values['oauth_signature'] = $key; + break; + case 'HMAC-SHA1': + $uri = strtok($url, '?'); + $sign = $method.'&'.$this->Encode($uri).'&'; + $first = true; + $sign_values = $values; + $u = parse_url($url); + if(IsSet($u['query'])) + { + parse_str($u['query'], $q); + foreach($q as $parameter => $value) + $sign_values[$parameter] = $value; + } + KSort($sign_values); + foreach($sign_values as $parameter => $value) + { + $sign .= $this->Encode(($first ? '' : '&').$parameter.'='.$this->Encode($value)); + $first = false; + } + $values['oauth_signature'] = base64_encode($this->HMAC('sha1', $sign, $key)); + break; + default: + return $this->SetError($this->signature_method.' signature method is not yet supported'); + } + if($this->authorization_header) + { + $authorization = 'OAuth'; + $first = true; + foreach($values as $parameter => $value) + { + $authorization .= ($first ? ' ' : ',').$parameter.'="'.$this->Encode($value).'"'; + $first = false; + } + } + else + { + if($method === 'GET' + || (IsSet($options['PostValuesInURI']) + && $options['PostValuesInURI'])) + { + $first = (strcspn($url, '?') == strlen($url)); + foreach($values as $parameter => $value) + { + $url .= ($first ? '?' : '&').$parameter.'='.$this->Encode($value); + $first = false; + } + $post_values = array(); + } + else + $post_values = $values; + } + } + if(strlen($error = $http->GetRequestArguments($url, $arguments))) + return($this->SetError('it was not possible to open the '.$options['Resource'].' URL: '.$error)); + if(strlen($error = $http->Open($arguments))) + return($this->SetError('it was not possible to open the '.$options['Resource'].' URL: '.$error)); + if(count($post_files)) + $arguments['PostFiles'] = $post_files; + $arguments['RequestMethod'] = $method; + switch($type) + { + case 'application/x-www-form-urlencoded': + case 'multipart/form-data': + if(IsSet($options['RequestBody'])) + return($this->SetError('the request body is defined automatically from the parameters')); + $arguments['PostValues'] = $parameters; + break; + case 'application/json': + $arguments['Headers']['Content-Type'] = $options['RequestContentType']; + if(!IsSet($options['RequestBody'])) + { + $arguments['Body'] = json_encode($parameters); + break; + } + default: + if(!IsSet($options['RequestBody'])) + return($this->SetError('it was not specified the body value of the of the API call request')); + $arguments['Headers']['Content-Type'] = $options['RequestContentType']; + $arguments['Body'] = $options['RequestBody']; + break; + } + $arguments['Headers']['Accept'] = (IsSet($options['Accept']) ? $options['Accept'] : '*/*'); + if(strlen($authorization)) + $arguments['Headers']['Authorization'] = $authorization; + if(strlen($error = $http->SendRequest($arguments)) + || strlen($error = $http->ReadReplyHeaders($headers))) + { + $http->Close(); + return($this->SetError('it was not possible to retrieve the '.$options['Resource'].': '.$error)); + } + $error = $http->ReadWholeReplyBody($data); + $http->Close(); + if(strlen($error)) + { + return($this->SetError('it was not possible to access the '.$options['Resource'].': '.$error)); + } + $this->response_status = intval($http->response_status); + $content_type = (IsSet($options['ResponseContentType']) ? $options['ResponseContentType'] : (IsSet($headers['content-type']) ? strtolower(trim(strtok($headers['content-type'], ';'))) : 'unspecified')); + switch($content_type) + { + case 'text/javascript': + case 'application/json': + if(!function_exists('json_decode')) + return($this->SetError('the JSON extension is not available in this PHP setup')); + $object = json_decode($data); + switch(GetType($object)) + { + case 'object': + if(!IsSet($options['ConvertObjects']) + || !$options['ConvertObjects']) + $response = $object; + else + { + $response = array(); + foreach($object as $property => $value) + $response[$property] = $value; + } + break; + case 'array': + $response = $object; + break; + default: + if(!IsSet($object)) + return($this->SetError('it was not returned a valid JSON definition of the '.$options['Resource'].' values')); + $response = $object; + break; + } + break; + case 'application/x-www-form-urlencoded': + case 'text/plain': + case 'text/html': + parse_str($data, $response); + break; + default: + $response = $data; + break; + } + if($this->response_status >= 200 + && $this->response_status < 300) + $this->access_token_error = ''; + else + { + $this->access_token_error = 'it was not possible to access the '.$options['Resource'].': it was returned an unexpected response status '.$http->response_status.' Response: '.$data; + if($this->debug) + $this->OutputDebug('Could not retrieve the OAuth access. Error: '.$this->access_token_error); + if(IsSet($options['FailOnAccessError']) + && $options['FailOnAccessError']) + { + $this->error = $this->access_token_error; + return false; + } + } + return true; + } + + Function ProcessToken($code, $refresh) + { + if($refresh) + { + $values = array( + 'client_id'=>$this->client_id, + 'client_secret'=>$this->client_secret, + 'refresh_token'=>$this->refresh_token, + 'grant_type'=>'refresh_token' + ); + } + else + { + if(!$this->GetRedirectURI($redirect_uri)) + return false; + $values = array( + 'code'=>$code, + 'client_id'=>$this->client_id, + 'client_secret'=>$this->client_secret, + 'redirect_uri'=>$redirect_uri, + 'grant_type'=>'authorization_code' + ); + } + if(!$this->GetAccessTokenURL($url)) + return false; + if(!$this->SendAPIRequest($url, 'POST', $values, null, array('Resource'=>'OAuth '.($refresh ? 'refresh' : 'access').' token', 'ConvertObjects'=>true), $response)) + return false; + if(strlen($this->access_token_error)) + { + $this->authorization_error = $this->access_token_error; + return true; + } + if(!IsSet($response['access_token'])) + { + if(IsSet($response['error'])) + { + $this->authorization_error = 'it was not possible to retrieve the access token: it was returned the error: '.$response['error']; + return true; + } + return($this->SetError('OAuth server did not return the access token')); + } + $access_token = array( + 'value'=>$this->access_token = $response['access_token'], + 'authorized'=>true + ); + if($this->debug) + $this->OutputDebug('Access token: '.$this->access_token); + if(IsSet($response['expires']) + || IsSet($response['expires_in'])) + { + $expires = (IsSet($response['expires']) ? $response['expires'] : $response['expires_in']); + if(strval($expires) !== strval(intval($expires)) + || $expires <= 0) + return($this->SetError('OAuth server did not return a supported type of access token expiry time')); + $this->access_token_expiry = gmstrftime('%Y-%m-%d %H:%M:%S', time() + $expires); + if($this->debug) + $this->OutputDebug('Access token expiry: '.$this->access_token_expiry.' UTC'); + $access_token['expiry'] = $this->access_token_expiry; + } + else + $this->access_token_expiry = ''; + if(IsSet($response['token_type'])) + { + $this->access_token_type = $response['token_type']; + if($this->debug) + $this->OutputDebug('Access token type: '.$this->access_token_type); + $access_token['type'] = $this->access_token_type; + } + else + $this->access_token_type = ''; + if($refresh) + $response['refresh_token'] = $this->refresh_token; + elseif(IsSet($response['refresh_token'])) + { + $this->refresh_token = $response['refresh_token']; + if($this->debug) + $this->OutputDebug('Refresh token: '.$this->refresh_token); + $access_token['refresh'] = $this->refresh_token; + } + else + $this->refresh_token = ''; + if(!$this->StoreAccessToken($access_token)) + return false; + return true; + } + + Function RetrieveToken(&$valid) + { + $valid = false; + if(!$this->GetAccessToken($access_token)) + return false; + if(IsSet($access_token['value'])) + { + $this->access_token_expiry = ''; + if(IsSet($access_token['expiry']) + && strcmp($this->access_token_expiry = $access_token['expiry'], gmstrftime('%Y-%m-%d %H:%M:%S')) < 0) + { + $this->access_token = ''; + if($this->debug) + $this->OutputDebug('The OAuth access token expired in '.$this->access_token_expiry); + } + else + { + $this->access_token = $access_token['value']; + if(IsSet($access_token['type'])) + $this->access_token_type = $access_token['type']; + else + $this->access_token_type = ''; + if($this->debug) + $this->OutputDebug('The OAuth access token '.$this->access_token.' is valid'); + if(strlen($this->access_token_type) + && $this->debug) + $this->OutputDebug('The OAuth access token is of type '.$this->access_token_type); + if(IsSet($access_token['refresh'])) + $this->refresh_token = $access_token['refresh']; + else + $this->refresh_token = ''; + $valid = true; + } + } + return true; + } +/* +{metadocument} + + CallAPI + BOOLEAN + + Send a HTTP request to the Web services API using a + previously obtained authorization token via OAuth. + This function can be used to call an API after having + previously obtained an access token through the OAuth protocol + using the Process function, or by + directly setting the variables + access_token, as well as + access_token_secret in case of using + OAuth 1.0 or 1.0a services. + This function returns 1 if + the call was done successfully. + + + url + STRING + + URL of the API where the HTTP request will be sent. + + + + method + STRING + + HTTP method that will be used to send the request. It can + be GET, + POST, + DELETE, PUT, + etc.. + + + + parameters + HASH + + Associative array with the names and values of the API + call request parameters. + + + + options + HASH + + Associative array with additional options to configure + the request. Currently it supports the following + options: + 2Legged: boolean option that + determines if the API request should be 2 legged. The default + value is 0. + Accept: content type value of the + Accept HTTP header to be sent in the API call HTTP request. + Some APIs require that a certain value be sent to specify + which version of the API is being called. The default value is + */*. + ConvertObjects: boolean option that + determines if objects should be converted into arrays when the + response is returned in JSON format. The default value is + 0. + FailOnAccessError: boolean option + that determines if this functions should fail when the server + response status is not between 200 and 299. The default value + is 0. + Files: associative array with + details of the parameters that must be passed as file uploads. + The array indexes must have the same name of the parameters + to be sent as files. The respective array entry values must + also be associative arrays with the parameters for each file. + Currently it supports the following parameters: + - Type - defines how the parameter value should be + treated. It can be 'FileName' if the parameter value is + is the name of a local file to be uploaded. It may also be + 'Data' if the parameter value is the actual data of + the file to be uploaded. + - Default: 'FileName' + - ContentType - MIME value of the content type of the + file. It can be 'automatic/name' if the content type + should be determine from the file name extension. + - Default: 'automatic/name' + PostValuesInURI: boolean option to + determine that a POST request should pass the request values + in the URI. The default value is + 0. + FollowRedirection: limit number of + times that HTTP response redirects will be followed. If it is + set to 0, redirection responses + fail in error. The default value is + 0. + RequestBody: request body data of a + custom type. The RequestContentType + option must be specified, so the + RequestBody option is considered. + RequestContentType: content type that + should be used to send the request values. It can be either + application/x-www-form-urlencoded + for sending values like from Web forms, or + application/json for sending the + values encoded in JSON format. Other types are accepted if the + RequestBody option is specified. + The default value is + application/x-www-form-urlencoded. + RequestBody: request body data of a + custom type. The RequestContentType + option must be specified, so the + RequestBody option is considered. + Resource: string with a label that + will be used in the error messages and debug log entries to + identify what operation the request is performing. The default + value is API call. + ResponseContentType: content type + that should be considered when decoding the API request + response. This overrides the Content-Type header + returned by the server. If the content type is + application/x-www-form-urlencoded + the function will parse the data returning an array of + key-value pairs. If the content type is + application/json the response will + be decode as a JSON-encoded data type. Other content type + values will make the function return the original response + value as it was returned from the server. The default value + for this option is to use what the server returned in the + Content-Type header. + + + + response + STRING + + + Return the value of the API response. If the value is + JSON encoded, this function will decode it and return the value + converted to respective types. If the value is form encoded, + this function will decode the response and return it as an + array. Otherwise, the class will return the value as a + string. + + + +{/metadocument} +*/ + Function CallAPI($url, $method, $parameters, $options, &$response) + { + if(!IsSet($options['Resource'])) + $options['Resource'] = 'API call'; + if(!IsSet($options['ConvertObjects'])) + $options['ConvertObjects'] = false; + if(strlen($this->access_token) === 0) + { + if(!$this->RetrieveToken($valid)) + return false; + if(!$valid) + return $this->SetError('the access token is not set to a valid value'); + } + switch(intval($this->oauth_version)) + { + case 1: + $oauth = array( + 'oauth_token'=>((IsSet($options['2Legged']) && $options['2Legged']) ? '' : $this->access_token) + ); + break; + + case 2: + if(strlen($this->access_token_expiry) + && strcmp($this->access_token_expiry, gmstrftime('%Y-%m-%d %H:%M:%S')) <= 0) + { + if(strlen($this->refresh_token) === 0) + return($this->SetError('the access token expired and no refresh token is available')); + if($this->debug) + { + $this->OutputDebug('The access token expired on '.$this->access_token_expiry); + $this->OutputDebug('Refreshing the access token'); + } + if(!$this->ProcessToken(null, true)) + return false; + } + $oauth = null; + $url .= (strcspn($url, '?') < strlen($url) ? '&' : '?').'access_token='.UrlEncode($this->access_token); + break; + + default: + return($this->SetError($this->oauth_version.' is not a supported version of the OAuth protocol')); + } + return($this->SendAPIRequest($url, $method, $parameters, $oauth, $options, $response)); + } +/* +{metadocument} + + +{/metadocument} +*/ + +/* +{metadocument} + + Initialize + BOOLEAN + + Initialize the class variables and internal state. It must + be called before calling other class functions. + Set the server variable before + calling this function to let it initialize the class variables to + work with the specified server type. Alternatively, you can set + other class variables manually to make it work with servers that + are not yet built-in supported. + This function returns 1 if + it was able to successfully initialize the class for the specified + server type. + + +{/metadocument} +*/ + Function Initialize() + { + if(strlen($this->server) === 0) + return true; + $this->request_token_url = ''; + $this->append_state_to_redirect_uri = ''; + $this->authorization_header = true; + $this->url_parameters = false; + $this->token_request_method = 'GET'; + $this->signature_method = 'HMAC-SHA1'; + switch($this->server) + { + case 'Bitbucket': + $this->oauth_version = '1.0a'; + $this->request_token_url = 'https://bitbucket.org/!api/1.0/oauth/request_token'; + $this->dialog_url = 'https://bitbucket.org/!api/1.0/oauth/authenticate'; + $this->access_token_url = 'https://bitbucket.org/!api/1.0/oauth/access_token'; + $this->url_parameters = true; + break; + + case 'Box': + $this->oauth_version = '2.0'; + $this->dialog_url = 'https://www.box.com/api/oauth2/authorize?response_type=code&client_id={CLIENT_ID}&redirect_uri={REDIRECT_URI}&state={STATE}'; + $this->offline_dialog_url = 'https://www.box.com/api/oauth2/authorize?response_type=code&client_id={CLIENT_ID}&redirect_uri={REDIRECT_URI}&state={STATE}&access_type=offline&approval_prompt=force'; + $this->access_token_url = 'https://www.box.com/api/oauth2/token'; + break; + + case 'Dropbox': + $this->oauth_version = '1.0'; + $this->request_token_url = 'https://api.dropbox.com/1/oauth/request_token'; + $this->dialog_url = 'https://www.dropbox.com/1/oauth/authorize'; + $this->access_token_url = 'https://api.dropbox.com/1/oauth/access_token'; + $this->authorization_header = false; + break; + + case 'Eventful': + $this->oauth_version = '1.0a'; + $this->request_token_url = 'http://eventful.com/oauth/request_token'; + $this->dialog_url = 'http://eventful.com/oauth/authorize'; + $this->access_token_url = 'http://eventful.com/oauth/access_token'; + $this->authorization_header = false; + $this->url_parameters = true; + $this->token_request_method = 'POST'; + break; + + case 'Evernote': + $this->oauth_version = '1.0a'; + $this->request_token_url = 'https://sandbox.evernote.com/oauth'; + $this->dialog_url = 'https://sandbox.evernote.com/OAuth.action'; + $this->access_token_url = 'https://sandbox.evernote.com/oauth'; + $this->url_parameters = true; + $this->authorization_header = false; + break; + + case 'Facebook': + $this->oauth_version = '2.0'; + $this->dialog_url = 'https://www.facebook.com/dialog/oauth?client_id={CLIENT_ID}&redirect_uri={REDIRECT_URI}&scope={SCOPE}&state={STATE}'; + $this->access_token_url = 'https://graph.facebook.com/oauth/access_token'; + break; + + case 'Fitbit': + $this->oauth_version = '1.0a'; + $this->request_token_url = 'http://api.fitbit.com/oauth/request_token'; + $this->dialog_url = 'http://api.fitbit.com/oauth/authorize'; + $this->access_token_url = 'http://api.fitbit.com/oauth/access_token'; + break; + + case 'Flickr': + $this->oauth_version = '1.0a'; + $this->request_token_url = 'http://www.flickr.com/services/oauth/request_token'; + $this->dialog_url = 'http://www.flickr.com/services/oauth/authorize?perms={SCOPE}'; + $this->access_token_url = 'http://www.flickr.com/services/oauth/access_token'; + $this->authorization_header = false; + break; + + case 'Foursquare': + $this->oauth_version = '2.0'; + $this->dialog_url = 'https://foursquare.com/oauth2/authorize?client_id={CLIENT_ID}&scope={SCOPE}&response_type=code&redirect_uri={REDIRECT_URI}&state={STATE}'; + $this->access_token_url = 'https://foursquare.com/oauth2/access_token'; + break; + + case 'github': + $this->oauth_version = '2.0'; + $this->dialog_url = 'https://github.com/login/oauth/authorize?client_id={CLIENT_ID}&redirect_uri={REDIRECT_URI}&scope={SCOPE}&state={STATE}'; + $this->access_token_url = 'https://github.com/login/oauth/access_token'; + break; + + case 'Google': + $this->oauth_version = '2.0'; + $this->dialog_url = 'https://accounts.google.com/o/oauth2/auth?response_type=code&client_id={CLIENT_ID}&redirect_uri={REDIRECT_URI}&scope={SCOPE}&state={STATE}'; + $this->offline_dialog_url = 'https://accounts.google.com/o/oauth2/auth?response_type=code&client_id={CLIENT_ID}&redirect_uri={REDIRECT_URI}&scope={SCOPE}&state={STATE}&access_type=offline&approval_prompt=force'; + $this->access_token_url = 'https://accounts.google.com/o/oauth2/token'; + break; + + case 'Instagram': + $this->oauth_version = '2.0'; + $this->dialog_url ='https://api.instagram.com/oauth/authorize/?client_id={CLIENT_ID}&redirect_uri={REDIRECT_URI}&scope={SCOPE}&response_type=code&state={STATE}'; + $this->access_token_url = 'https://api.instagram.com/oauth/access_token'; + break; + + case 'LinkedIn': + $this->oauth_version = '1.0a'; + $this->request_token_url = 'https://api.linkedin.com/uas/oauth/requestToken?scope={SCOPE}'; + $this->dialog_url = 'https://api.linkedin.com/uas/oauth/authenticate'; + $this->access_token_url = 'https://api.linkedin.com/uas/oauth/accessToken'; + $this->url_parameters = true; + break; + + case 'Microsoft': + $this->oauth_version = '2.0'; + $this->dialog_url = 'https://login.live.com/oauth20_authorize.srf?client_id={CLIENT_ID}&scope={SCOPE}&response_type=code&redirect_uri={REDIRECT_URI}&state={STATE}'; + $this->access_token_url = 'https://login.live.com/oauth20_token.srf'; + break; + + case 'RightSignature': + $this->oauth_version = '1.0a'; + $this->request_token_url = 'https://rightsignature.com/oauth/request_token'; + $this->dialog_url = 'https://rightsignature.com/oauth/authorize'; + $this->access_token_url = 'https://rightsignature.com/oauth/access_token'; + $this->authorization_header = false; + break; + + case 'Scoop.it': + $this->oauth_version = '1.0a'; + $this->request_token_url = 'https://www.scoop.it/oauth/request'; + $this->dialog_url = 'https://www.scoop.it/oauth/authorize'; + $this->access_token_url = 'https://www.scoop.it/oauth/access'; + $this->authorization_header = false; + break; + + case 'StockTwits': + $this->oauth_version = '2.0'; + $this->dialog_url = 'https://api.stocktwits.com/api/2/oauth/authorize?client_id={CLIENT_ID}&response_type=code&redirect_uri={REDIRECT_URI}&scope={SCOPE}&state={STATE}'; + $this->access_token_url = 'https://api.stocktwits.com/api/2/oauth/token'; + break; + + case 'Tumblr': + $this->oauth_version = '1.0a'; + $this->request_token_url = 'http://www.tumblr.com/oauth/request_token'; + $this->dialog_url = 'http://www.tumblr.com/oauth/authorize'; + $this->access_token_url = 'http://www.tumblr.com/oauth/access_token'; + break; + + case 'Twitter': + $this->oauth_version = '1.0a'; + $this->request_token_url = 'https://api.twitter.com/oauth/request_token'; + $this->dialog_url = 'https://api.twitter.com/oauth/authenticate'; + $this->access_token_url = 'https://api.twitter.com/oauth/access_token'; + $this->url_parameters = true; + break; + + case 'XING': + $this->oauth_version = '1.0a'; + $this->request_token_url = 'https://api.xing.com/v1/request_token'; + $this->dialog_url = 'https://api.xing.com/v1/authorize'; + $this->access_token_url = 'https://api.xing.com/v1/access_token'; + $this->authorization_header = false; + break; + + case 'Yahoo': + $this->oauth_version = '1.0a'; + $this->request_token_url = 'https://api.login.yahoo.com/oauth/v2/get_request_token'; + $this->dialog_url = 'https://api.login.yahoo.com/oauth/v2/request_auth'; + $this->access_token_url = 'https://api.login.yahoo.com/oauth/v2/get_token'; + $this->authorization_header = false; + break; + + default: + return($this->SetError($this->server.' is not yet a supported type of OAuth server. Please contact the author Manuel Lemos to request adding built-in support to this type of OAuth server.')); + } + return(true); + } +/* +{metadocument} + + +{/metadocument} +*/ + +/* +{metadocument} + + Process + BOOLEAN + + Process the OAuth protocol interaction with the OAuth + server. + Call this function when you need to retrieve the OAuth access + token. Check the access_token to + determine if the access token was obtained successfully. + This function returns 1 if + the OAuth protocol was processed without errors. + + +{/metadocument} +*/ + Function Process() + { + switch(intval($this->oauth_version)) + { + case 1: + $one_a = ($this->oauth_version === '1.0a'); + if($this->debug) + $this->OutputDebug('Checking the OAuth token authorization state'); + if(!$this->GetAccessToken($access_token)) + return false; + if(IsSet($access_token['authorized']) + && IsSet($access_token['value'])) + { + $expired = (IsSet($access_token['expiry']) && strcmp($access_token['expiry'], gmstrftime('%Y-%m-%d %H:%M:%S')) <= 0); + if(!$access_token['authorized'] + || $expired) + { + if($this->debug) + { + if($expired) + $this->OutputDebug('The OAuth token expired on '.$access_token['expiry'].'UTC'); + else + $this->OutputDebug('The OAuth token is not yet authorized'); + $this->OutputDebug('Checking the OAuth token and verifier'); + } + if(!$this->GetRequestToken($token, $verifier)) + return false; + if(!IsSet($token) + || ($one_a + && !IsSet($verifier))) + { + if(!$this->GetRequestDenied($denied)) + return false; + if(IsSet($denied) + && $denied === $access_token['value']) + { + if($this->debug) + $this->OutputDebug('The authorization request was denied'); + $this->authorization_error = 'the request was denied'; + return true; + } + else + { + if($this->debug) + $this->OutputDebug('Reset the OAuth token state because token and verifier are not both set'); + $access_token = array(); + } + } + elseif($token !== $access_token['value']) + { + if($this->debug) + $this->OutputDebug('Reset the OAuth token state because token does not match what as previously retrieved'); + $access_token = array(); + } + else + { + if(!$this->GetAccessTokenURL($url)) + return false; + $oauth = array( + 'oauth_token'=>$token, + ); + if($one_a) + $oauth['oauth_verifier'] = $verifier; + $this->access_token_secret = $access_token['secret']; + $options = array('Resource'=>'OAuth access token'); + $method = strtoupper($this->token_request_method); + switch($method) + { + case 'GET': + break; + case 'POST': + $options['PostValuesInURI'] = true; + break; + default: + $this->error = $method.' is not a supported method to request tokens'; + break; + } + if(!$this->SendAPIRequest($url, $method, array(), $oauth, $options, $response)) + return false; + if(strlen($this->access_token_error)) + { + $this->authorization_error = $this->access_token_error; + return true; + } + if(!IsSet($response['oauth_token']) + || !IsSet($response['oauth_token_secret'])) + { + $this->authorization_error= 'it was not returned the access token and secret'; + return true; + } + $access_token = array( + 'value'=>$response['oauth_token'], + 'secret'=>$response['oauth_token_secret'], + 'authorized'=>true + ); + if(IsSet($response['oauth_expires_in'])) + { + $expires = $response['oauth_expires_in']; + if(strval($expires) !== strval(intval($expires)) + || $expires <= 0) + return($this->SetError('OAuth server did not return a supported type of access token expiry time')); + $this->access_token_expiry = gmstrftime('%Y-%m-%d %H:%M:%S', time() + $expires); + if($this->debug) + $this->OutputDebug('Access token expiry: '.$this->access_token_expiry.' UTC'); + $access_token['expiry'] = $this->access_token_expiry; + } + else + $this->access_token_expiry = ''; + + if(!$this->StoreAccessToken($access_token)) + return false; + if($this->debug) + $this->OutputDebug('The OAuth token was authorized'); + } + } + elseif($this->debug) + $this->OutputDebug('The OAuth token was already authorized'); + if(IsSet($access_token['authorized']) + && $access_token['authorized']) + { + $this->access_token = $access_token['value']; + $this->access_token_secret = $access_token['secret']; + return true; + } + } + else + { + if($this->debug) + $this->OutputDebug('The OAuth access token is not set'); + $access_token = array(); + } + if(!IsSet($access_token['authorized'])) + { + if($this->debug) + $this->OutputDebug('Requesting the unauthorized OAuth token'); + if(!$this->GetRequestTokenURL($url)) + return false; + $url = str_replace('{SCOPE}', UrlEncode($this->scope), $url); + if(!$this->GetRedirectURI($redirect_uri)) + return false; + $oauth = array( + 'oauth_callback'=>$redirect_uri, + ); + $options = array('Resource'=>'OAuth request token'); + $method = strtoupper($this->token_request_method); + switch($method) + { + case 'GET': + break; + case 'POST': + $options['PostValuesInURI'] = true; + break; + default: + $this->error = $method.' is not a supported method to request tokens'; + break; + } + if(!$this->SendAPIRequest($url, $method, array(), $oauth, $options, $response)) + return false; + if(strlen($this->access_token_error)) + { + $this->authorization_error = $this->access_token_error; + return true; + } + if(!IsSet($response['oauth_token']) + || !IsSet($response['oauth_token_secret'])) + { + $this->authorization_error = 'it was not returned the requested token'; + return true; + } + $access_token = array( + 'value'=>$response['oauth_token'], + 'secret'=>$response['oauth_token_secret'], + 'authorized'=>false + ); + if(!$this->StoreAccessToken($access_token)) + return false; + } + if(!$this->GetDialogURL($url)) + return false; + $url .= (strpos($url, '?') === false ? '?' : '&').'oauth_token='.$access_token['value']; + if(!$one_a) + { + if(!$this->GetRedirectURI($redirect_uri)) + return false; + $url .= '&oauth_callback='.UrlEncode($redirect_uri); + } + if($this->debug) + $this->OutputDebug('Redirecting to OAuth authorize page '.$url); + Header('HTTP/1.0 302 OAuth Redirection'); + Header('Location: '.$url); + $this->exit = true; + return true; + + case 2: + if($this->debug) + $this->OutputDebug('Checking if OAuth access token was already retrieved from '.$this->access_token_url); + if(!$this->RetrieveToken($valid)) + return false; + if($valid) + return true; + if($this->debug) + $this->OutputDebug('Checking the authentication state in URI '.$_SERVER['REQUEST_URI']); + if(!$this->GetStoredState($stored_state)) + return false; + if(strlen($stored_state) == 0) + return($this->SetError('it was not set the OAuth state')); + if(!$this->GetRequestState($state)) + return false; + if($state === $stored_state) + { + if($this->debug) + $this->OutputDebug('Checking the authentication code'); + if(!$this->GetRequestCode($code)) + return false; + if(strlen($code) == 0) + { + if(!$this->GetRequestError($this->authorization_error)) + return false; + if(IsSet($this->authorization_error)) + { + if($this->debug) + $this->OutputDebug('Authorization failed with error code '.$this->authorization_error); + switch($this->authorization_error) + { + case 'invalid_request': + case 'unauthorized_client': + case 'access_denied': + case 'unsupported_response_type': + case 'invalid_scope': + case 'server_error': + case 'temporarily_unavailable': + case 'user_denied': + return true; + default: + return($this->SetError('it was returned an unknown OAuth error code')); + } + } + return($this->SetError('it was not returned the OAuth dialog code')); + } + if(!$this->ProcessToken($code, false)) + return false; + } + else + { + if(!$this->GetRedirectURI($redirect_uri)) + return false; + if(strlen($this->append_state_to_redirect_uri)) + $redirect_uri .= (strpos($redirect_uri, '?') === false ? '?' : '&').$this->append_state_to_redirect_uri.'='.$stored_state; + if(!$this->GetDialogURL($url, $redirect_uri, $stored_state)) + return false; + if(strlen($url) == 0) + return($this->SetError('it was not set the OAuth dialog URL')); + if($this->debug) + $this->OutputDebug('Redirecting to OAuth Dialog '.$url); + Header('HTTP/1.0 302 OAuth Redirection'); + Header('Location: '.$url); + $this->exit = true; + } + break; + + default: + return($this->SetError($this->oauth_version.' is not a supported version of the OAuth protocol')); + } + return(true); + } +/* +{metadocument} + + +{/metadocument} +*/ + +/* +{metadocument} + + Finalize + BOOLEAN + + Cleanup any resources that may have been used during the + OAuth protocol processing or execution of API calls. + Always call this function as the last step after calling the + functions Process or + CallAPI. + This function returns 1 if + the function cleaned up any resources successfully. + + + success + BOOLEAN + + Pass the last success state returned by the class or any + external code processing the class function results. + + + +{/metadocument} +*/ + Function Finalize($success) + { + return($success); + } +/* +{metadocument} + + +{/metadocument} +*/ + +/* +{metadocument} + + Output + VOID + + Display the results of the OAuth protocol processing. + Only call this function if you are debugging the OAuth + authorization process and you need to view what was its + results. + + +{/metadocument} +*/ + Function Output() + { + if(strlen($this->authorization_error) + || strlen($this->access_token_error) + || strlen($this->access_token)) + { +?> + + + +OAuth client result + + +

OAuth client result

+authorization_error)) + { +?> +

It was not possible to authorize the application.debug) + { +?> +
Authorization error: authorization_error); + } +?>

+access_token_error)) + { +?> +

It was not possible to use the application access token. +debug) + { +?> +
Error: access_token_error); + } +?>

+access_token)) + { +?> +

The application authorization was obtained successfully. +debug) + { +?> +
Access token: access_token); + if(IsSet($this->access_token_secret)) + { +?> +
Access token secret: access_token_secret); + } + } +?>

+access_token_expiry)) + { +?> +

Access token expiry: access_token_expiry; ?> UTC

+ + + + + +{/metadocument} +*/ + +}; + +/* + +{metadocument} + +{/metadocument} + +*/ + +?> \ No newline at end of file diff --git a/library/oauth/oauth_client_class.html b/library/oauth/oauth_client_class.html new file mode 100644 index 000000000..690730a7e --- /dev/null +++ b/library/oauth/oauth_client_class.html @@ -0,0 +1,607 @@ + + + +Class: OAuth client + + +

Class: OAuth client

+
+ +
+
    +

  • Summary

    • +
      +

      Name

      +

      OAuth client

      +

      Author

      +

      Manuel Lemos (mlemos-at-acm.org)

      +

      Copyright

      +

      Copyright © (C) Manuel Lemos 2012

      +

      Version

      +

      @(#) $Id: oauth_client.php,v 1.58 2013/04/11 09:33:16 mlemos Exp $

      +

      Purpose

      +

      This class serves two main purposes:

      +

      1) Implement the OAuth protocol to retrieve a token from a server to authorize the access to an API on behalf of the current user.

      +

      2) Perform calls to a Web services API using a token previously obtained using this class or a token provided some other way by the Web services provider.

      +

      Usage

      +

      Regardless of your purposes, you always need to start calling the class Initialize function after initializing setup variables. After you are done with the class, always call the Finalize function at the end.

      +

      This class supports either OAuth protocol versions 1.0, 1.0a and 2.0. It abstracts the differences between these protocol versions, so the class usage is the same independently of the OAuth version of the server.

      +

      The class also provides built-in support to several popular OAuth servers, so you do not have to manually configure all the details to access those servers. Just set the server variable to configure the class to access one of the built-in supported servers.

      +

      If you need to access one type of server that is not yet directly supported by the class, you need to configure it explicitly setting the variables: oauth_version, url_parameters, authorization_header, request_token_url, dialog_url, offline_dialog_url, append_state_to_redirect_uri and access_token_url.

      +

      Before proceeding to the actual OAuth authorization process, you need to have registered your application with the OAuth server. The registration provides you values to set the variables client_id and client_secret.

      +

      You also need to set the variables redirect_uri and scope before calling the Process function to make the class perform the necessary interactions with the OAuth server.

      +

      The OAuth protocol involves multiple steps that include redirection to the OAuth server. There it asks permission to the current user to grant your application access to APIs on his/her behalf. When there is a redirection, the class will set the exit variable to 1. Then your script should exit immediately without outputting anything.

      +

      When the OAuth access token is successfully obtained, the following variables are set by the class with the obtained values: access_token, access_token_secret, access_token_expiry, access_token_type. You may want to store these values to use them later when calling the server APIs.

      +

      If there was a problem during OAuth authorization process, check the variable authorization_error to determine the reason.

      +

      Once you get the access token, you can call the server APIs using the CallAPI function. Check the access_token_error variable to determine if there was an error when trying to to call the API.

      +

      If for some reason the user has revoked the access to your application, you need to ask the user to authorize your application again. First you may need to call the function ResetAccessToken to reset the value of the access token that may be cached in session variables.

      +

      Table of contents

      +
    +
+
+
    +

  • Variables

    • +
      +
    • error

      • +
    • debug

      • +
    • debug_http

      • +
    • exit

      • +
    • debug_output

      • +
    • debug_prefix

      • +
    • server

      • +
    • request_token_url

      • +
    • dialog_url

      • +
    • offline_dialog_url

      • +
    • append_state_to_redirect_uri

      • +
    • access_token_url

      • +
    • oauth_version

      • +
    • url_parameters

      • +
    • authorization_header

      • +
    • token_request_method

      • +
    • signature_method

      • +
    • redirect_uri

      • +
    • client_id

      • +
    • client_secret

      • +
    • scope

      • +
    • offline

      • +
    • access_token

      • +
    • access_token_secret

      • +
    • access_token_expiry

      • +
    • access_token_type

      • +
    • refresh_token

      • +
    • access_token_error

      • +
    • authorization_error

      • +
    • response_status

      • +

      Table of contents

      +

    • error

      • +

      Type

      +

      string

      +

      Default value

      +

      ''

      +

      Purpose

      +

      Store the message that is returned when an error occurs.

      +

      Usage

      +

      Check this variable to understand what happened when a call to any of the class functions has failed.

      +

      This class uses cumulative error handling. This means that if one class functions that may fail is called and this variable was already set to an error message due to a failure in a previous call to the same or other function, the function will also fail and does not do anything.

      +

      This allows programs using this class to safely call several functions that may fail and only check the failure condition after the last function call.

      +

      Just set this variable to an empty string to clear the error condition.

      +

      Variables

      +

    • debug

      • +

      Type

      +

      bool

      +

      Default value

      +

      0

      +

      Purpose

      +

      Control whether debug output is enabled

      +

      Usage

      +

      Set this variable to 1 if you need to check what is going on during calls to the class. When enabled, the debug output goes either to the variable debug_output and the PHP error log.

      +

      Variables

      +

    • debug_http

      • +

      Type

      +

      bool

      +

      Default value

      +

      0

      +

      Purpose

      +

      Control whether the dialog with the remote Web server should also be logged.

      +

      Usage

      +

      Set this variable to 1 if you want to inspect the data exchange with the OAuth server.

      +

      Variables

      +

    • exit

      • +

      Type

      +

      bool

      +

      Default value

      +

      0

      +

      Purpose

      +

      Determine if the current script should be exited.

      +

      Usage

      +

      Check this variable after calling the Process function and exit your script immediately if the variable is set to 1.

      +

      Variables

      +

    • debug_output

      • +

      Type

      +

      string

      +

      Default value

      +

      ''

      +

      Purpose

      +

      Capture the debug output generated by the class

      +

      Usage

      +

      Inspect this variable if you need to see what happened during the class function calls.

      +

      Variables

      +

    • debug_prefix

      • +

      Type

      +

      string

      +

      Default value

      +

      'OAuth client: '

      +

      Purpose

      +

      Mark the lines of the debug output to identify actions performed by this class.

      +

      Usage

      +

      Change this variable if you prefer the debug output lines to be prefixed with a different text.

      +

      Variables

      +

    • server

      • +

      Type

      +

      string

      +

      Default value

      +

      ''

      +

      Purpose

      +

      Identify the type of OAuth server to access.

      +

      Usage

      +

      The class provides built-in support to several types of OAuth servers. This means that the class can automatically initialize several configuration variables just by setting this server variable.

      +

      Currently it supports the following servers: 'Bitbucket', 'Box', 'Dropbox', 'Eventful', 'Facebook', 'Fitbit', 'Flickr', 'Foursquare', 'github', 'Google', 'Instagram', 'LinkedIn', 'Microsoft', 'Scoop.it', 'StockTwits', 'Tumblr', 'Twitter', 'XING' and 'Yahoo'. Please contact the author if you would like to ask to add built-in support for other types of OAuth servers.

      +

      If you want to access other types of OAuth servers that are not yet supported, set this variable to an empty string and configure other variables with values specific to those servers.

      +

      Variables

      +

    • request_token_url

      • +

      Type

      +

      string

      +

      Default value

      +

      ''

      +

      Purpose

      +

      URL of the OAuth server to request the initial token for OAuth 1.0 and 1.0a servers.

      +

      Usage

      +

      Set this variable to the OAuth request token URL when you are not accessing one of the built-in supported OAuth servers.

      +

      For OAuth 1.0 and 1.0a servers, the request token URL can have certain marks that will act as template placeholders which will be replaced with given values before requesting the authorization token. Currently it supports the following placeholder marks:

      +

      {SCOPE} - scope of the requested permissions to the granted by the OAuth server with the user permissions

      +

      Variables

      +

    • dialog_url

      • +

      Type

      +

      string

      +

      Default value

      +

      ''

      +

      Purpose

      +

      URL of the OAuth server to redirect the browser so the user can grant access to your application.

      +

      Usage

      +

      Set this variable to the OAuth request token URL when you are not accessing one of the built-in supported OAuth servers.

      +

      For certain servers, the dialog URL can have certain marks that will act as template placeholders which will be replaced with values defined before redirecting the users browser. Currently it supports the following placeholder marks:

      +

      {REDIRECT_URI} - URL to redirect when returning from the OAuth server authorization page

      +

      {CLIENT_ID} - client application identifier registered at the server

      +

      {SCOPE} - scope of the requested permissions to the granted by the OAuth server with the user permissions

      +

      {STATE} - identifier of the OAuth session state

      +

      Variables

      +

    • offline_dialog_url

      • +

      Type

      +

      string

      +

      Default value

      +

      ''

      +

      Purpose

      +

      URL of the OAuth server to redirect the browser so the user can grant access to your application when offline access is requested.

      +

      Usage

      +

      Set this variable to the OAuth request token URL when you are not accessing one of the built-in supported OAuth servers and the OAuth server supports offline access.

      +

      It should have the same format as the dialog_url variable.

      +

      Variables

      +

    • append_state_to_redirect_uri

      • +

      Type

      +

      string

      +

      Default value

      +

      ''

      +

      Purpose

      +

      Pass the OAuth session state in a variable with a different name to work around implementation bugs of certain OAuth servers

      +

      Usage

      +

      Set this variable when you are not accessing one of the built-in supported OAuth servers if the OAuth server has a bug that makes it not pass back the OAuth state identifier in a request variable named state.

      +

      Variables

      +

    • access_token_url

      • +

      Type

      +

      string

      +

      Default value

      +

      ''

      +

      Purpose

      +

      OAuth server URL that will return the access token URL.

      +

      Usage

      +

      Set this variable to the OAuth access token URL when you are not accessing one of the built-in supported OAuth servers.

      +

      Variables

      +

    • oauth_version

      • +

      Type

      +

      string

      +

      Default value

      +

      '2.0'

      +

      Purpose

      +

      Version of the protocol version supported by the OAuth server.

      +

      Usage

      +

      Set this variable to the OAuth server protocol version when you are not accessing one of the built-in supported OAuth servers.

      +

      Variables

      +

    • url_parameters

      • +

      Type

      +

      bool

      +

      Default value

      +

      0

      +

      Purpose

      +

      Determine if the API call parameters should be moved to the call URL.

      +

      Usage

      +

      Set this variable to 1 if the API you need to call requires that the call parameters always be passed via the API URL.

      +

      Variables

      +

    • authorization_header

      • +

      Type

      +

      bool

      +

      Default value

      +

      1

      +

      Purpose

      +

      Determine if the OAuth parameters should be passed via HTTP Authorization request header.

      +

      Usage

      +

      Set this variable to 1 if the OAuth server requires that the OAuth parameters be passed using the HTTP Authorization instead of the request URI parameters.

      +

      Variables

      +

    • token_request_method

      • +

      Type

      +

      string

      +

      Default value

      +

      'GET'

      +

      Purpose

      +

      Define the HTTP method that should be used to request tokens from the server.

      +

      Usage

      +

      Set this variable to 'POST' if the OAuth server does not support requesting tokens using the HTTP GET method.

      +

      Variables

      +

    • signature_method

      • +

      Type

      +

      string

      +

      Default value

      +

      'HMAC-SHA1'

      +

      Purpose

      +

      Define the method to generate the signature for API request parameters values.

      +

      Usage

      +

      Currently it supports 'PLAINTEXT' and 'HMAC-SHA1'.

      +

      Variables

      +

    • redirect_uri

      • +

      Type

      +

      string

      +

      Default value

      +

      ''

      +

      Purpose

      +

      URL of the current script page that is calling this class

      +

      Usage

      +

      Set this variable to the current script page URL before proceeding the the OAuth authorization process.

      +

      Variables

      +

    • client_id

      • +

      Type

      +

      string

      +

      Default value

      +

      ''

      +

      Purpose

      +

      Identifier of your application registered with the OAuth server

      +

      Usage

      +

      Set this variable to the application identifier that is provided by the OAuth server when you register the application.

      +

      Variables

      +

    • client_secret

      • +

      Type

      +

      string

      +

      Default value

      +

      ''

      +

      Purpose

      +

      Secret value assigned to your application when it is registered with the OAuth server.

      +

      Usage

      +

      Set this variable to the application secret that is provided by the OAuth server when you register the application.

      +

      Variables

      +

    • scope

      • +

      Type

      +

      string

      +

      Default value

      +

      ''

      +

      Purpose

      +

      Permissions that your application needs to call the OAuth server APIs

      +

      Usage

      +

      Check the documentation of the APIs that your application needs to call to set this variable with the identifiers of the permissions that the user needs to grant to your application.

      +

      Variables

      +

    • offline

      • +

      Type

      +

      bool

      +

      Default value

      +

      0

      +

      Purpose

      +

      Specify whether it will be necessary to call the API when the user is not present and the server supports renewing expired access tokens using refresh tokens.

      +

      Usage

      +

      Set this variable to 1 if the server supports renewing expired tokens automatically when the user is not present.

      +

      Variables

      +

    • access_token

      • +

      Type

      +

      string

      +

      Default value

      +

      ''

      +

      Purpose

      +

      Access token obtained from the OAuth server

      +

      Usage

      +

      Check this variable to get the obtained access token upon successful OAuth authorization.

      +

      Variables

      +

    • access_token_secret

      • +

      Type

      +

      string

      +

      Default value

      +

      ''

      +

      Purpose

      +

      Access token secret obtained from the OAuth server

      +

      Usage

      +

      If the OAuth protocol version is 1.0 or 1.0a, check this variable to get the obtained access token secret upon successful OAuth authorization.

      +

      Variables

      +

    • access_token_expiry

      • +

      Type

      +

      string

      +

      Default value

      +

      ''

      +

      Purpose

      +

      Timestamp of the expiry of the access token obtained from the OAuth server.

      +

      Usage

      +

      Check this variable to get the obtained access token expiry time upon successful OAuth authorization. If this variable is empty, that means no expiry time was set.

      +

      Variables

      +

    • access_token_type

      • +

      Type

      +

      string

      +

      Default value

      +

      ''

      +

      Purpose

      +

      Type of access token obtained from the OAuth server.

      +

      Usage

      +

      Check this variable to get the obtained access token type upon successful OAuth authorization.

      +

      Variables

      +

    • refresh_token

      • +

      Type

      +

      string

      +

      Default value

      +

      ''

      +

      Purpose

      +

      Refresh token obtained from the OAuth server

      +

      Usage

      +

      Check this variable to get the obtained refresh token upon successful OAuth authorization.

      +

      Variables

      +

    • access_token_error

      • +

      Type

      +

      string

      +

      Default value

      +

      ''

      +

      Purpose

      +

      Error message returned when a call to the API fails.

      +

      Usage

      +

      Check this variable to determine if there was an error while calling the Web services API when using the CallAPI function.

      +

      Variables

      +

    • authorization_error

      • +

      Type

      +

      string

      +

      Default value

      +

      ''

      +

      Purpose

      +

      Error message returned when it was not possible to obtain an OAuth access token

      +

      Usage

      +

      Check this variable to determine if there was an error while trying to obtain the OAuth access token.

      +

      Variables

      +

    • response_status

      • +

      Type

      +

      int

      +

      Default value

      +

      0

      +

      Purpose

      +

      HTTP response status returned by the server when calling an API

      +

      Usage

      +

      Check this variable after calling the CallAPI function if the API calls and you need to process the error depending the response status. 200 means no error. 0 means the server response was not retrieved.

      +

      Variables

      +

      Table of contents

      +
    +
+
+
    +

  • Functions

    • +
      +
    • StoreAccessToken

      • +
    • GetAccessToken

      • +
    • ResetAccessToken

      • +
    • CallAPI

      • +
    • Initialize

      • +
    • Process

      • +
    • Finalize

      • +
    • Output

      • +

      Table of contents

      +

    • StoreAccessToken

      • +

      Synopsis

      +

      bool StoreAccessToken(

      +)

      +

      Purpose

      +

      Store the values of the access token when it is succefully retrieved from the OAuth server.

      +

      Usage

      +

      This function is meant to be only be called from inside the class. By default it stores access tokens in a session variable named 'OAUTH_ACCESS_TOKEN'.

      +

      Actual implementations should create a sub-class and override this function to make the access token values be stored in other types of containers, like for instance databases.

      +

      Arguments

      +
        +

        access_token - Associative array with properties of the access token. The array may have set the following properties:

        +

        'value': string value of the access token

        +

        'authorized': boolean value that determines if the access token was obtained successfully

        +

        'expiry': (optional) timestamp in ISO format relative to UTC time zone of the access token expiry time

        +

        'type': (optional) type of OAuth token that may determine how it should be used when sending API call requests.

        +

        'refresh': (optional) token that some servers may set to allowing refreshing access tokens when they expire.

        +
      +

      Return value

      +

      This function should return 1 if the access token was stored successfully.

      +

      Functions

      +

    • GetAccessToken

      • +

      Synopsis

      +

      bool GetAccessToken(

      +)

      +

      Purpose

      +

      Retrieve the OAuth access token if it was already previously stored by the StoreAccessToken function.

      +

      Usage

      +

      This function is meant to be only be called from inside the class. By default it retrieves access tokens stored in a session variable named 'OAUTH_ACCESS_TOKEN'.

      +

      Actual implementations should create a sub-class and override this function to retrieve the access token values from other types of containers, like for instance databases.

      +

      Arguments

      +
        +

        access_token - Return the properties of the access token in an associative array. If the access token was not yet stored, it returns an empty array. Otherwise, the properties it may return are the same that may be passed to the StoreAccessToken.

        +
      +

      Return value

      +

      This function should return 1 if the access token was retrieved successfully.

      +

      Functions

      +

    • ResetAccessToken

      • +

      Synopsis

      +

      bool ResetAccessToken()

      +

      Purpose

      +

      Reset the access token to a state back when the user has not yet authorized the access to the OAuth server API.

      +

      Usage

      +

      Call this function if for some reason the token to access the API was revoked and you need to ask the user to authorize the access again.

      +

      By default the class stores and retrieves access tokens in a session variable named 'OAUTH_ACCESS_TOKEN'.

      +

      This function must be called when the user is accessing your site pages, so it can reset the information stored in session variables that cache the state of a previously retrieved access token.

      +

      Actual implementations should create a sub-class and override this function to reset the access token state when it is stored in other types of containers, like for instance databases.

      +

      Return value

      +

      This function should return 1 if the access token was resetted successfully.

      +

      Functions

      +

    • CallAPI

      • +

      Synopsis

      +

      bool CallAPI(

      +)

      +

      Purpose

      +

      Send a HTTP request to the Web services API using a previously obtained authorization token via OAuth.

      +

      Usage

      +

      This function can be used to call an API after having previously obtained an access token through the OAuth protocol using the Process function, or by directly setting the variables access_token, as well as access_token_secret in case of using OAuth 1.0 or 1.0a services.

      +

      Arguments

      +
        +

        url - URL of the API where the HTTP request will be sent.

        +

        method - HTTP method that will be used to send the request. It can be 'GET', 'POST', 'DELETE', 'PUT', etc..

        +

        parameters - Associative array with the names and values of the API call request parameters.

        +

        options - Associative array with additional options to configure the request. Currently it supports the following options:

        +

        '2Legged': boolean option that determines if the API request should be 2 legged. The default value is 0.

        +

        'Accept': content type value of the Accept HTTP header to be sent in the API call HTTP request. Some APIs require that a certain value be sent to specify which version of the API is being called. The default value is '*/*'.

        +

        'ConvertObjects': boolean option that determines if objects should be converted into arrays when the response is returned in JSON format. The default value is 0.

        +

        'FailOnAccessError': boolean option that determines if this functions should fail when the server response status is not between 200 and 299. The default value is 0.

        +

        'Files': associative array with details of the parameters that must be passed as file uploads. The array indexes must have the same name of the parameters to be sent as files. The respective array entry values must also be associative arrays with the parameters for each file. Currently it supports the following parameters:

        +

        - Type - defines how the parameter value should be treated. It can be 'FileName' if the parameter value is is the name of a local file to be uploaded. It may also be 'Data' if the parameter value is the actual data of the file to be uploaded.

        +

        - Default: 'FileName'

        +

        - ContentType - MIME value of the content type of the file. It can be 'automatic/name' if the content type should be determine from the file name extension.

        +

        - Default: 'automatic/name'

        +

        'PostValuesInURI': boolean option to determine that a POST request should pass the request values in the URI. The default value is 0.

        +

        'FollowRedirection': limit number of times that HTTP response redirects will be followed. If it is set to 0, redirection responses fail in error. The default value is 0.

        +

        'RequestBody': request body data of a custom type. The 'RequestContentType' option must be specified, so the 'RequestBody' option is considered.

        +

        'RequestContentType': content type that should be used to send the request values. It can be either 'application/x-www-form-urlencoded' for sending values like from Web forms, or 'application/json' for sending the values encoded in JSON format. Other types are accepted if the 'RequestBody' option is specified. The default value is 'application/x-www-form-urlencoded'.

        +

        'RequestBody': request body data of a custom type. The 'RequestContentType' option must be specified, so the 'RequestBody' option is considered.

        +

        'Resource': string with a label that will be used in the error messages and debug log entries to identify what operation the request is performing. The default value is 'API call'.

        +

        'ResponseContentType': content type that should be considered when decoding the API request response. This overrides the Content-Type header returned by the server. If the content type is 'application/x-www-form-urlencoded' the function will parse the data returning an array of key-value pairs. If the content type is 'application/json' the response will be decode as a JSON-encoded data type. Other content type values will make the function return the original response value as it was returned from the server. The default value for this option is to use what the server returned in the Content-Type header.

        +

        response - Return the value of the API response. If the value is JSON encoded, this function will decode it and return the value converted to respective types. If the value is form encoded, this function will decode the response and return it as an array. Otherwise, the class will return the value as a string.

        +
      +

      Return value

      +

      This function returns 1 if the call was done successfully.

      +

      Functions

      +

    • Initialize

      • +

      Synopsis

      +

      bool Initialize()

      +

      Purpose

      +

      Initialize the class variables and internal state. It must be called before calling other class functions.

      +

      Usage

      +

      Set the server variable before calling this function to let it initialize the class variables to work with the specified server type. Alternatively, you can set other class variables manually to make it work with servers that are not yet built-in supported.

      +

      Return value

      +

      This function returns 1 if it was able to successfully initialize the class for the specified server type.

      +

      Functions

      +

    • Process

      • +

      Synopsis

      +

      bool Process()

      +

      Purpose

      +

      Process the OAuth protocol interaction with the OAuth server.

      +

      Usage

      +

      Call this function when you need to retrieve the OAuth access token. Check the access_token to determine if the access token was obtained successfully.

      +

      Return value

      +

      This function returns 1 if the OAuth protocol was processed without errors.

      +

      Functions

      +

    • Finalize

      • +

      Synopsis

      +

      bool Finalize(

      +)

      +

      Purpose

      +

      Cleanup any resources that may have been used during the OAuth protocol processing or execution of API calls.

      +

      Usage

      +

      Always call this function as the last step after calling the functions Process or CallAPI.

      +

      Arguments

      +
        +

        success - Pass the last success state returned by the class or any external code processing the class function results.

        +
      +

      Return value

      +

      This function returns 1 if the function cleaned up any resources successfully.

      +

      Functions

      +

    • Output

      • +

      Synopsis

      +

      Output()

      +

      Purpose

      +

      Display the results of the OAuth protocol processing.

      +

      Usage

      +

      Only call this function if you are debugging the OAuth authorization process and you need to view what was its results.

      +

      Functions

      +

      Table of contents

      +
    +
+ +
+
Manuel Lemos (mlemos-at-acm.org)
+ + From 4d91b6e6d243eacb12faffb4d4ce2a3eec85f820 Mon Sep 17 00:00:00 2001 From: friendica Date: Mon, 15 Sep 2014 22:53:33 -0700 Subject: [PATCH 11/32] fat finger - must have been here a while --- mod/admin.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mod/admin.php b/mod/admin.php index 836b12281..9a35a8de8 100644 --- a/mod/admin.php +++ b/mod/admin.php @@ -768,7 +768,7 @@ function admin_page_channels_post(&$a){ ); proc_run('php','include/directory.php',$uid,'nopush'); } - notice( sprintf( tt("%s channel censored/uncensored", "%s channelss censored/uncensored", count($channels)), count($channels)) ); + notice( sprintf( tt("%s channel censored/uncensored", "%s channels censored/uncensored", count($channels)), count($channels)) ); } if (x($_POST,'page_channels_delete')){ require_once("include/Contact.php"); From b2f2424b5272f7c58343fe810f303b55f1b7bf5e Mon Sep 17 00:00:00 2001 From: friendica Date: Mon, 15 Sep 2014 23:11:08 -0700 Subject: [PATCH 12/32] push individual block to directory --- mod/admin.php | 1 + 1 file changed, 1 insertion(+) diff --git a/mod/admin.php b/mod/admin.php index 9a35a8de8..68ce6fe85 100644 --- a/mod/admin.php +++ b/mod/admin.php @@ -814,6 +814,7 @@ function admin_page_channels(&$a){ intval(PAGE_CENSORED), intval( $uid ) ); + proc_run('php','include/directory.php',$uid,'nopush'); notice( sprintf( (($channel[0]['channel_pageflags'] & PAGE_CENSORED) ? t("Channel '%s' uncensored"): t("Channel '%s' censored")) , $channel[0]['channel_name'] . ' (' . $channel[0]['channel_address'] . ')' ) . EOL); }; break; From a1b66f56f0981a0853f180a458c401a80dda28ce Mon Sep 17 00:00:00 2001 From: friendica Date: Tue, 16 Sep 2014 03:33:48 -0700 Subject: [PATCH 13/32] use the more portable encoded_item format for exported items - but with added attributes so we can use it as a reasonably complete item backup. The encoded_item format gives us extended author and owner information in case we need to probe them to bring the entry back. It also contains taxonomy entries. Importing and/or recovering will best be accomplished in chunks. It could take some time and some memory to chew through this. --- include/identity.php | 18 ++++++------------ include/items.php | 28 +++++++++++++++++++++++++--- version.inc | 2 +- 3 files changed, 32 insertions(+), 16 deletions(-) diff --git a/include/identity.php b/include/identity.php index 1078ff082..2039738e0 100644 --- a/include/identity.php +++ b/include/identity.php @@ -489,18 +489,12 @@ function identity_basic_export($channel_id, $items = false) { intval($channel_id) ); if($r) { - for($x = 0; $x < count($r); $x ++) { - if($r[$x]['diaspora_meta']) - $r[$x]['diaspora_meta'] = crypto_unencapsulate(json_decode($r[$x]['diaspora_meta'],true),$key); - if($r[$x]['item_flags'] & ITEM_OBSCURED) { - $r[$x]['item_flags'] = $r[$x]['item_flags'] ^ ITEM_OBSCURED; - if($r[$x]['title']) - $r[$x]['title'] = crypto_unencapsulate(json_decode($r[$x]['title'],true),$key); - if($r[$x]['body']) - $r[$x]['body'] = crypto_unencapsulate(json_decode($r[$x]['body'],true),$key); - } - } - $ret['item'] = $r; + $ret['item'] = array(); + xchan_query($r); + $r = fetch_post_tags($r,true); + foreach($r as $rr) + $ret['item'][] = encode_item($rr,true); + } return $ret; diff --git a/include/items.php b/include/items.php index beec65d8a..1fa833eb2 100755 --- a/include/items.php +++ b/include/items.php @@ -1007,8 +1007,7 @@ function import_author_unknown($x) { } - -function encode_item($item) { +function encode_item($item,$mirror = false) { $x = array(); $x['type'] = 'activity'; $x['encoding'] = 'zot'; @@ -1030,14 +1029,37 @@ function encode_item($item) { $c_scope = map_scope($comment_scope); + $key = get_config('system','prvkey'); + if(array_key_exists('item_flags',$item) && ($item['item_flags'] & ITEM_OBSCURED)) { - $key = get_config('system','prvkey'); if($item['title']) $item['title'] = crypto_unencapsulate(json_decode_plus($item['title']),$key); if($item['body']) $item['body'] = crypto_unencapsulate(json_decode_plus($item['body']),$key); } + // If we're trying to backup an item so that it's recoverable or for export/imprt, + // add all the attributes we need to recover it + + if($mirror) { + $x['id'] = $item['id']; + $x['parent'] = $item['parent']; + $x['uid'] = $item['uid']; + $x['allow_cid'] = $item['allow_cid']; + $x['allow_gid'] = $item['allow_gid']; + $x['deny_cid'] = $item['deny_cid']; + $x['deny_gid'] = $item['deny_gid']; + $x['revision'] = $item['revision']; + $x['layout_mid'] = $item['layout_mid']; + $x['postopts'] = $item['postopts']; + $x['resource_id'] = $item['resource_id']; + $x['resource_type'] = $item['resource_type']; + $x['item_restrict'] = $item['item_restrict']; + $x['item_flags'] = $item['item_flags']; + $x['diaspora_meta'] = crypto_unencapsulate(json_decode($item['diaspora_meta'],true),$key); + $x['attach'] = $item['attach']; + } + $x['message_id'] = $item['mid']; $x['message_top'] = $item['parent_mid']; diff --git a/version.inc b/version.inc index c3d994d3e..973190772 100644 --- a/version.inc +++ b/version.inc @@ -1 +1 @@ -2014-09-15.799 +2014-09-16.800 From 6a82ccecd08e84dff0f4e3198693823d7019c6d2 Mon Sep 17 00:00:00 2001 From: friendica Date: Tue, 16 Sep 2014 05:14:06 -0700 Subject: [PATCH 14/32] when importing channels - use the new location notification message to tell your original site where it sits in terms of primary. --- mod/import.php | 13 ++++--------- 1 file changed, 4 insertions(+), 9 deletions(-) diff --git a/mod/import.php b/mod/import.php index 0663a8b57..2fbb71fc4 100644 --- a/mod/import.php +++ b/mod/import.php @@ -379,21 +379,17 @@ function import_post(&$a) { //FIXME just a note here for when folks want to import content - be very careful to unset ITEM_ORIGIN on all imported content. Or you could end up with a nasty routing loop when somebody tries to reply to one of those posts. - - - // FIXME - ensure we have a self entry if somebody is trying to pull a fast one - if($seize) { - // notify old server that it is no longer primary. - - } + // send out refresh requests + // notify old server that it may no longer be primary. + + proc_run('php','include/notifier.php','location',$channel['channel_id']); // This will indirectly perform a refresh_all *and* update the directory proc_run('php', 'include/directory.php', $channel['channel_id']); - // send out refresh requests notice( t('Import completed.') . EOL); @@ -401,7 +397,6 @@ function import_post(&$a) { goaway(z_root() . '/network' ); - } From b5bb2230ebd9648e30c79efed6ffe672a2ae19bf Mon Sep 17 00:00:00 2001 From: marijus Date: Tue, 16 Sep 2014 14:18:03 +0200 Subject: [PATCH 15/32] this still has less issues --- view/js/main.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/view/js/main.js b/view/js/main.js index d6b405258..2e297c9d6 100644 --- a/view/js/main.js +++ b/view/js/main.js @@ -1114,7 +1114,7 @@ $(window).scroll(function () { $('#more').show(); } - if($(window).scrollTop() + $(window).height() == $(document).height()) { + if($(window).scrollTop() + $(window).height() > $(document).height() - 100) { if((pageHasMoreContent) && (! loadingPage)) { $('#more').hide(); $('#no-more').hide(); @@ -1134,7 +1134,7 @@ $(window).scroll(function () { $('#more').show(); } - if($(window).scrollTop() + $(window).height() == $(document).height()) { + if($(window).scrollTop() + $(window).height() > $(document).height() - 100) { if((pageHasMoreContent) && (! loadingPage) && (! justifiedGalleryActive)) { $('#more').hide(); $('#no-more').hide(); From 5bdfc2f64780abd36d889dc0bbe52026b768631b Mon Sep 17 00:00:00 2001 From: Alexandre Hannud Abdo Date: Tue, 16 Sep 2014 18:56:34 -0300 Subject: [PATCH 16/32] Fix name attribute of button elements so jquery '.submit()' doesn't break According to "Additional notes" in: http://api.jquery.com/submit/ Not fixing buttons created with 'input' tags. --- view/tpl/comment_item.tpl | 2 +- view/tpl/jot.tpl | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/view/tpl/comment_item.tpl b/view/tpl/comment_item.tpl index 351cc8e14..e68314797 100755 --- a/view/tpl/comment_item.tpl +++ b/view/tpl/comment_item.tpl @@ -58,7 +58,7 @@ {{/if}} - +
diff --git a/view/tpl/jot.tpl b/view/tpl/jot.tpl index c4fdba0f5..c51dc02a5 100755 --- a/view/tpl/jot.tpl +++ b/view/tpl/jot.tpl @@ -85,7 +85,7 @@ {{/if}} - +
From c4608d4c827881b0f0fa5e2031de3fbd5b0568d7 Mon Sep 17 00:00:00 2001 From: friendica Date: Tue, 16 Sep 2014 19:07:19 -0700 Subject: [PATCH 17/32] just mark dead hubloc deleted - don't remove them. This could cause problems. Also clean up fetch_url/post_url header option --- include/network.php | 15 ++++----------- include/photos.php | 1 + include/zot.php | 6 ++++-- 3 files changed, 9 insertions(+), 13 deletions(-) diff --git a/include/network.php b/include/network.php index 0191f203d..e84ea91f4 100644 --- a/include/network.php +++ b/include/network.php @@ -38,6 +38,7 @@ function z_fetch_url($url, $binary = false, $redirects = 0, $opts = array()) { return false; @curl_setopt($ch, CURLOPT_HEADER, true); + @curl_setopt($ch, CURLINFO_HEADER_OUT, true); @curl_setopt($ch, CURLOPT_CAINFO, get_capath()); @curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true); @curl_setopt($ch, CURLOPT_RETURNTRANSFER,true); @@ -47,11 +48,8 @@ function z_fetch_url($url, $binary = false, $redirects = 0, $opts = array()) { if($ciphers) @curl_setopt($ch, CURLOPT_SSL_CIPHER_LIST, $ciphers); - if (x($opts,'accept_content')){ - @curl_setopt($ch,CURLOPT_HTTPHEADER, array ( - "Accept: " . $opts['accept_content'] - )); - } + if(x($opts,'headers')) + @curl_setopt($ch, CURLOPT_HTTPHEADER, $opts['headers']); if(x($opts,'timeout') && intval($opts['timeout'])) { @curl_setopt($ch, CURLOPT_TIMEOUT, $opts['timeout']); @@ -166,6 +164,7 @@ function z_post_url($url,$params, $redirects = 0, $opts = array()) { return ret; @curl_setopt($ch, CURLOPT_HEADER, true); + @curl_setopt($ch, CURLINFO_HEADER_OUT, true); @curl_setopt($ch, CURLOPT_CAINFO, get_capath()); @curl_setopt($ch, CURLOPT_RETURNTRANSFER,true); @curl_setopt($ch, CURLOPT_POST,1); @@ -176,12 +175,6 @@ function z_post_url($url,$params, $redirects = 0, $opts = array()) { if($ciphers) @curl_setopt($ch, CURLOPT_SSL_CIPHER_LIST, $ciphers); - - if (x($opts,'accept_content')){ - @curl_setopt($ch,CURLOPT_HTTPHEADER, array ( - "Accept: " . $opts['accept_content'] - )); - } if(x($opts,'headers')) @curl_setopt($ch, CURLOPT_HTTPHEADER, $opts['headers']); diff --git a/include/photos.php b/include/photos.php index 06a99457a..badbbd791 100644 --- a/include/photos.php +++ b/include/photos.php @@ -266,6 +266,7 @@ function photo_upload($channel, $observer, $args) { proc_run('php', "include/notifier.php", 'wall-new', $item_id); $ret['success'] = true; + $ret['item'] = $arr; $ret['body'] = $arr['body']; $ret['resource_id'] = $photo_hash; $ret['photoitem_id'] = $item_id; diff --git a/include/zot.php b/include/zot.php index add44e288..b7ffe14e4 100644 --- a/include/zot.php +++ b/include/zot.php @@ -1844,8 +1844,10 @@ function sync_locations($sender,$arr,$absolute = false) { if($absolute && $xisting) { foreach($xisting as $x) { if(! array_key_exists('updated',$x)) { - logger('sync_locations: removing unreferenced hub location ' . $x['hubloc_url']); - $r = q("delete from hubloc where hubloc_id = %d limit 1", + logger('sync_locations: deleting unreferenced hub location ' . $x['hubloc_url']); + $r = q("update hubloc set hubloc_flags = (hubloc_flags ^ %d), hubloc_updated = '%s' where hubloc_id = %d limit 1", + intval(HUBLOC_FLAGS_DELETED), + dbesc(datetime_convert()), intval($x['hubloc_id']) ); $what .= 'removed_hub'; From 53d0e855dfaeccfebd55d0b3c91cf040b2e317a4 Mon Sep 17 00:00:00 2001 From: friendica Date: Tue, 16 Sep 2014 20:46:44 -0700 Subject: [PATCH 18/32] z_post_url_json() added to easily deal with JSON post APIs; without getting content-type unknown warnings/errors. Also added a debug option to z_get|post_url so you could track and log some of these nasty little buggers. --- include/network.php | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/include/network.php b/include/network.php index e84ea91f4..7286f0b12 100644 --- a/include/network.php +++ b/include/network.php @@ -124,6 +124,10 @@ function z_fetch_url($url, $binary = false, $redirects = 0, $opts = array()) { } $ret['body'] = substr($s,strlen($header)); $ret['header'] = $header; + + if(x($opts,'debug')) { + $ret['debug'] = $curl_info; + } @curl_close($ch); return($ret); @@ -251,11 +255,24 @@ function z_post_url($url,$params, $redirects = 0, $opts = array()) { $ret['body'] = substr($s,strlen($header)); $ret['header'] = $header; + + if(x($opts,'debug')) { + $ret['debug'] = $curl_info; + } + + curl_close($ch); return($ret); } +function z_post_url_json($url,$params,$redirects = 0, $opts = array()) { + + $opts = array_merge($opts,array('headers' => array('Content-Type: application/json'))); + return z_post_url($url,json_encode($params),$redirects,$opts); + +} + function json_return_and_die($x) { header("content-type: application/json"); From 19e8d10b7a877618c9a2b97bf6be9fb2e80a4ea4 Mon Sep 17 00:00:00 2001 From: friendica Date: Tue, 16 Sep 2014 21:08:34 -0700 Subject: [PATCH 19/32] still some old Friendica database queries in diaspora_signed_retraction --- include/diaspora.php | 32 +++++++++++++++----------------- 1 file changed, 15 insertions(+), 17 deletions(-) diff --git a/include/diaspora.php b/include/diaspora.php index ea3c78bfe..3b6321643 100755 --- a/include/diaspora.php +++ b/include/diaspora.php @@ -2043,35 +2043,33 @@ function diaspora_signed_retraction($importer,$xml,$msg) { } if($type === 'StatusMessage' || $type === 'Comment' || $type === 'Like') { - $r = q("select * from item where guid = '%s' and uid = %d and not file like '%%[%%' limit 1", + $r = q("select * from item where mid = '%s' and uid = %d limit 1", dbesc($guid), intval($importer['channel_id']) ); - if(count($r)) { - if(link_compare($r[0]['author-link'],$contact['url'])) { - q("update item set `deleted` = 1, `edited` = '%s', `changed` = '%s', `body` = '' , `title` = '' where `id` = %d", - dbesc(datetime_convert()), - dbesc(datetime_convert()), - intval($r[0]['id']) - ); + if($r) { + if($r[0]['author_xchan'] == $contact['xchan_hash']) { + + drop_item($r[0]['id'],false, DROPITEM_PHASE1); // Now check if the retraction needs to be relayed by us // // The first item in the `item` table with the parent id is the parent. However, MySQL doesn't always // return the items ordered by `item`.`id`, in which case the wrong item is chosen as the parent. // The only item with `parent` and `id` as the parent id is the parent item. - $p = q("select origin from item where parent = %d and id = %d limit 1", + $p = q("select item_flags from item where parent = %d and id = %d limit 1", $r[0]['parent'], $r[0]['parent'] ); - if(count($p)) { - if(($p[0]['origin']) && (! $parent_author_signature)) { - q("insert into sign (`retract_iid`,`signed_text`,`signature`,`signer`) values (%d,'%s','%s','%s') ", - $r[0]['id'], - dbesc($signed_data), - dbesc($sig), - dbesc($diaspora_handle) - ); + if($p) { + if(($p[0]['item_flags'] & ITEM_ORIGIN) && (! $parent_author_signature)) { +// FIXME so we can relay this +// q("insert into sign (`retract_iid`,`signed_text`,`signature`,`signer`) values (%d,'%s','%s','%s') ", +// $r[0]['id'], +// dbesc($signed_data), +// dbesc($sig), +// dbesc($diaspora_handle) +// ); // the existence of parent_author_signature would have meant the parent_author or owner // is already relaying. From 0090cbf84b6679a72ac164dfb86a701ed0faa601 Mon Sep 17 00:00:00 2001 From: friendica Date: Tue, 16 Sep 2014 22:26:52 -0700 Subject: [PATCH 20/32] that's why bb2diaspora_itemwallwall() wasn't doing its thang. --- include/bb2diaspora.php | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/include/bb2diaspora.php b/include/bb2diaspora.php index 846725639..e60f72add 100644 --- a/include/bb2diaspora.php +++ b/include/bb2diaspora.php @@ -269,12 +269,12 @@ function bb2diaspora_itemwallwall(&$item) { logger('bb2diaspora_itemwallwall: author: ' . print_r($item['author'],true), LOGGER_DEBUG); } - if(($item['mid'] == $item['parent_mid']) && ($item['author_xchan'] != $item['owner_xchan']) && (is_array($item['author'])) && $item['author']['url'] && $item['author']['name'] && $item['author']['photo']['src']) { + if(($item['mid'] == $item['parent_mid']) && ($item['author_xchan'] != $item['owner_xchan']) && (is_array($item['author'])) && $item['author']['xchan_url'] && $item['author']['xchan_name'] && $item['author']['xchan_photo_m']) { logger('bb2diaspora_itemwallwall: wall to wall post',LOGGER_DEBUG); // post will come across with the owner's identity. Throw a preamble onto the post to indicate the true author. $item['body'] = "\n\n" - . '[img]' . $item['author']['photo']['src'] . '[/img]' - . '[url=' . $item['author']['url'] . ']' . $item['author']['name'] . '[/url]' . "\n\n" + . '[img]' . $item['author']['xchan_photo_m'] . '[/img]' + . '[url=' . $item['author']['xchan_url'] . ']' . $item['author']['xchan_name'] . '[/url]' . "\n\n" . $item['body']; } } From cd790447782c0a7deba56209afc2e6352e004743 Mon Sep 17 00:00:00 2001 From: friendica Date: Tue, 16 Sep 2014 23:12:50 -0700 Subject: [PATCH 21/32] no sense maintaining 2 to-do files. I think the one I'm removing is referenced online somewhere - which is why it wasn't done earlier. Can't find it, so just note that somebody will complain and we'll have to edit the pointer someday. --- doc/To-Do-Code.md | 60 ----------------------------------------------- doc/To-Do.md | 23 ------------------ 2 files changed, 83 deletions(-) delete mode 100644 doc/To-Do-Code.md delete mode 100644 doc/To-Do.md diff --git a/doc/To-Do-Code.md b/doc/To-Do-Code.md deleted file mode 100644 index bdbbc6cdf..000000000 --- a/doc/To-Do-Code.md +++ /dev/null @@ -1,60 +0,0 @@ -Project Code To-Do List -======================= - -We need much more than this, but here are areas where developers can help. Please edit this page when items are finished. Another place for developers to start is with the issues list. - -* Documentation - see [Red Documentation Project To-Do List](help/To-Do) - -* Finish the anti-spam bayesian engine - -* Integrate the "open site" list with the register page - -* implement oembed provider interface - -* implement openid server interface - -* Write more webpage layouts - -* Write more webpage widgets - -* (Advanced) create a UI for building Comanche pages - -* External post connectors - create standard interface - -* External post connectors, add popular services - -* templatise and translate the Web interface to webDAV - -* Extend WebDAV to provide desktop access to photo albums - -* service classes - provide a pluggable subscription payment gateway for premium accounts - -* service classes - account overview page showing resources consumed by channel. With special consideration this page can also be accessed at a meta level by the site admin to drill down on problematic accounts/channels. - -* Events module - fix permissions on events, and provide JS translation support for the calendar overview; integrate with calDAV - -* Events module - event followups and RSVP - - -* Uploads - integrate https://github.com/blueimp/jQuery-File-Upload - -* App taxonomy - -* replace the tinymce visual editor and/or make the visual editor pluggable and responsive to different output formats. We probably want library/bbedit for bbcode. This needs a fair bit of work to catch up with our "enhanced bbcode", but start with images, links, bold and highlight and work from there. - -* Photos module - turn photos into normal conversations and fix tagging - -* Provide RSS feed support which look like channels (in matrix only - copyright issues) - -* Create mobile clients for the top platforms - which involves extending the API so that we can do stuff far beyond the current crop of Twitter/Statusnet clients. Ditto for mobile themes. We can probably use something like the Friendica Android app as a base to start from. - -* Implement owned and exchangeable "things". - -* Family Account creation - using service classes (an account holder can create a certain number of sub-accounts which are all tied to their subscription - if the subscription lapses they all go away). - -* Put mod_admin under Comanche - -In many cases some of the work has already been started and code exists so that you needn't start from scratch. Please contact one of the developer channels like Channel One (one@zothub.com) before embarking and we can tell you what we already have and provide some insights on how we envision these features fitting together. - - - \ No newline at end of file diff --git a/doc/To-Do.md b/doc/To-Do.md deleted file mode 100644 index 76b78b6ac..000000000 --- a/doc/To-Do.md +++ /dev/null @@ -1,23 +0,0 @@ -Documentation we need to write -============================== - - -* Database schema detailed descriptions - -* Complete plugin hook documentation - -* API documentation - -* Function and code documentation (doxygen) - -* New Member guide - -* "Extra Feature" reference, description of each - -* Detailed Personal Settings Documentation - -* Administration Guide (post-install) - -* Administration Guide (pre-install) - - From 401409357238183702c1628a02ccef6cf0394d72 Mon Sep 17 00:00:00 2001 From: friendica Date: Wed, 17 Sep 2014 17:59:46 -0700 Subject: [PATCH 22/32] implement permission roles - the backend should be done except for maybe a couple of small tweaks. Now we just need to define the rest of the roles and create a chooser for them. Adam started on this some time back but I don't know where that has gone. --- doc/to_do_code.bb | 16 +++++++++++ include/follow.php | 13 +++++++++ include/identity.php | 61 +++++++++++++++++++++++++++++++++++------ include/permissions.php | 11 +++++--- mod/connedit.php | 22 +++++++++++++++ version.inc | 2 +- view/js/mod_connedit.js | 13 +++++++-- 7 files changed, 122 insertions(+), 16 deletions(-) diff --git a/doc/to_do_code.bb b/doc/to_do_code.bb index 91997a284..0005b4be3 100644 --- a/doc/to_do_code.bb +++ b/doc/to_do_code.bb @@ -4,6 +4,8 @@ We need much more than this, but here are areas where developers can help. Pleas [li]Documentation - see Red Documentation Project To-Do List[/li] +[li]Include TOS link in registration/verification email[/li] + [li]Finish the anti-spam bayesian engine[/li] [li]If DAV folders exist, add an option to the Settings page to set a default folder for attachment uploads.[/li] @@ -38,8 +40,22 @@ We need much more than this, but here are areas where developers can help. Pleas [li]Uploads - integrate #^[url=https://github.com/blueimp/jQuery-File-Upload]https://github.com/blueimp/jQuery-File-Upload[/url][/li] +[li]Import/export - include items, events, things, etc.[/li] + +[li]Import channel from Diaspora/Friendica[/li] + +[li]MediaGoblin photo "crosspost" connector[/li] + +[li]Create management page/UI for extensible profile fields[/li] + +[li]Create interface to include/exclude and re-order standard profile fields[/li] + +[li]Provide a mechanism to share page design elements in posts (just like apps)[/li] + [li]App taxonomy[/li] +[li]Customisable App collection pages[/li] + [li]replace the tinymce visual editor and/or make the visual editor pluggable and responsive to different output formats. We probably want library/bbedit for bbcode. This needs a fair bit of work to catch up with our "enhanced bbcode", but start with images, links, bold and highlight and work from there.[/li] [li]Photos module - turn photos into normal conversations and fix tagging[/li] diff --git a/include/follow.php b/include/follow.php index 18a9e66ea..3c1fcd890 100644 --- a/include/follow.php +++ b/include/follow.php @@ -63,6 +63,13 @@ function new_contact($uid,$url,$channel,$interactive = false, $confirm = false) $my_perms = PERMS_W_STREAM|PERMS_W_MAIL; + $role = get_pconfig($uid,'system','permissions_role'); + if($role) { + $x = get_role_perms($role); + if($x['perms_follow']) + $my_perms = $x['perms_follow']; + } + logger('follow: ' . $url . ' ' . print_r($j,true), LOGGER_DEBUG); @@ -153,6 +160,12 @@ function new_contact($uid,$url,$channel,$interactive = false, $confirm = false) $xchan_hash = $r[0]['xchan_hash']; $their_perms = 0; $my_perms = PERMS_W_STREAM|PERMS_W_MAIL; + $role = get_pconfig($uid,'system','permissions_role'); + if($role) { + $x = get_role_perms($role); + if($x['perms_follow']) + $my_perms = $x['perms_follow']; + } } } diff --git a/include/identity.php b/include/identity.php index 2039738e0..38e96ab71 100644 --- a/include/identity.php +++ b/include/identity.php @@ -215,13 +215,31 @@ function create_identity($arr) { if(array_key_exists('primary', $arr)) $primary = intval($arr['primary']); + $perms_sql = ''; - $defperms = site_default_perms(); - $global_perms = get_perms(); - foreach($defperms as $p => $v) { - $perms_keys .= ', ' . $global_perms[$p][0]; - $perms_vals .= ', ' . intval($v); + $role_permissions = null; + + if(array_key_exists('permissions_role',$arr) && $arr['permissions_role']) { + $role_permissions = get_role_perms($arr['permissions_role']); + if($role_permissions) { + foreach($role_permissions as $p => $v) { + if(strpos($p,'channel_') !== false) { + $perms_keys .= ', ' . $global_perms[$p][0]; + $perms_vals .= ', ' . intval($v); + } + if($p === 'directory_publish') + $publish = intval($v); + } + } + } + else { + $defperms = site_default_perms(); + $global_perms = get_perms(); + foreach($defperms as $p => $v) { + $perms_keys .= ', ' . $global_perms[$p][0]; + $perms_vals .= ', ' . intval($v); + } } $expire = get_config('system', 'default_expire_days'); @@ -322,25 +340,52 @@ function create_identity($arr) { dbesc($a->get_baseurl() . "/photo/profile/m/{$newuid}") ); - $r = q("insert into abook ( abook_account, abook_channel, abook_xchan, abook_closeness, abook_created, abook_updated, abook_flags ) - values ( %d, %d, '%s', %d, '%s', '%s', %d ) ", + $myperms = 0; + if($role_permissions) { + $myperms = ((array_key_exists('perms_auto',$role_permissions) && $role_permissions['perms_auto']) ? intval($role_permissions['perms_accept']) : 0); + } + + $r = q("insert into abook ( abook_account, abook_channel, abook_xchan, abook_closeness, abook_created, abook_updated, abook_flags, abook_my_perms ) + values ( %d, %d, '%s', %d, '%s', '%s', %d, %d ) ", intval($ret['channel']['channel_account_id']), intval($newuid), dbesc($hash), intval(0), dbesc(datetime_convert()), dbesc(datetime_convert()), - intval(ABOOK_FLAG_SELF) + intval(ABOOK_FLAG_SELF), + intval($myperms) ); if(intval($ret['channel']['channel_account_id'])) { + // Save our permissions role so we can perhaps call it up and modify it later. + + if($role_permissions) + set_pconfig($newuid,'system','permissions_role',$arr['permissions_role']); + // Create a group with no members. This allows somebody to use it // right away as a default group for new contacts. require_once('include/group.php'); group_add($newuid, t('Friends')); + // if our role_permissions indicate that we're using a default collection ACL, add it. + + if(is_array($role_permissions) && $role_permissions['default_collection']) { + $r = q("select hash from groups where uid = %d and name = '%s' limit 1", + intval($newuid), + dbesc( t('Friends') ) + ); + if($r) { + q("update channel set channel_allow_gid = '%s' where channel_id = %d limit 1", + dbesc('<' . $r[0]['hash'] . '>'), + intval($newuid) + ); + } + } + + call_hooks('register_account', $newuid); proc_run('php','include/directory.php', $ret['channel']['channel_id']); diff --git a/include/permissions.php b/include/permissions.php index 8e4676f51..70c682cfc 100644 --- a/include/permissions.php +++ b/include/permissions.php @@ -419,11 +419,12 @@ function site_default_perms() { * * Given a string for the channel role ('social','forum', etc) * return an array of all permission fields pre-filled for this role. - * This includes the channel permission scope indicators as well as - * perms_auto: The permissions to apply automatically on receipt of a connection request + * This includes the channel permission scope indicators (anything beginning with 'channel_') as well as + * perms_auto: true or false to create auto-permissions for this channel * perms_follow: The permissions to apply when initiating a connection request to another channel * perms_accept: The permissions to apply when accepting a connection request from another channel (not automatic) - * + * default_collection: true or false to make the default ACL include the channel's default collection + * directory_publish: true or false to publish this channel in the directory * Any attributes may be extended (new roles defined) and modified (specific permissions altered) by plugins * */ @@ -436,7 +437,9 @@ function get_role_perms($role) { switch($role) { case 'social': - $ret['perms_auto'] = 0; + $ret['perms_auto'] = false; + $ret['default_collection'] = false; + $ret['directory_publish'] = true; $ret['perms_follow'] = PERMS_R_STREAM|PERMS_R_PROFILE|PERMS_R_PHOTOS|PERMS_R_ABOOK |PERMS_W_STREAM|PERMS_W_WALL|PERMS_W_COMMENT|PERMS_W_MAIL|PERMS_W_CHAT |PERMS_R_STORAGE|PERMS_R_PAGES|PERMS_A_REPUBLISH|PERMS_W_LIKE; diff --git a/mod/connedit.php b/mod/connedit.php index b2de42343..7ad719738 100644 --- a/mod/connedit.php +++ b/mod/connedit.php @@ -255,6 +255,28 @@ function connedit_content(&$a) { return login(); } + $my_perms = 0; + $role = get_pconfig(local_user(),'system','permissions_role'); + if($role) { + $x = get_role_perms($role); + if($x['perms_accept']) + $my_perms = $x['perms_accept']; + } + if($my_perms) { + $o .= "\n"; + } + if(argc() == 3) { $contact_id = intval(argv(1)); diff --git a/version.inc b/version.inc index 973190772..1213afd33 100644 --- a/version.inc +++ b/version.inc @@ -1 +1 @@ -2014-09-16.800 +2014-09-17.801 diff --git a/view/js/mod_connedit.js b/view/js/mod_connedit.js index 6231dbd0c..fabf24e95 100644 --- a/view/js/mod_connedit.js +++ b/view/js/mod_connedit.js @@ -6,11 +6,18 @@ function abook_perms_msg() { } $(document).ready(function() { - if(typeof(after_following) !== 'undefined' && after_following) - connectFullShare(); + if(typeof(after_following) !== 'undefined' && after_following) { + if(typeof(connectDefaultShare) !== 'undefined') + connectDefaultShare(); + else + connectFullShare(); + } $('#id_pending').click(function() { - connectFullShare(); + if(typeof(connectDefaultShare) !== 'undefined') + connectDefaultShare(); + else + connectFullShare(); }); $('.abook-edit-me').click(function() { From 618b93d42e54e0ecefb69d6e1acf24429d39785e Mon Sep 17 00:00:00 2001 From: friendica Date: Wed, 17 Sep 2014 19:08:15 -0700 Subject: [PATCH 23/32] let the xchan diagnostic accept a webbie --- mod/xchan.php | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/mod/xchan.php b/mod/xchan.php index e51cc53cc..a4dc70550 100644 --- a/mod/xchan.php +++ b/mod/xchan.php @@ -7,7 +7,7 @@ function xchan_content(&$a) { $o .= '

Xchan Lookup

'; $o .= '
'; - $o .= 'Lookup xchan beginning with: '; + $o .= 'Lookup xchan beginning with (or webbie): '; $o .= '
'; $o .= '

'; @@ -15,28 +15,28 @@ function xchan_content(&$a) { if(x($_GET,'addr')) { $addr = trim($_GET['addr']); - $r = q("select * from xchan where xchan_hash like '%s%%'", + $r = q("select * from xchan where xchan_hash like '%s%%' or xchan_addr = '%s' group by xchan_hash", + dbesc($addr), dbesc($addr) ); if($r) { - foreach($r as $rr) + foreach($r as $rr) { $o .= str_replace("\n","
",print_r($rr,true)) . EOL; + + $s = q("select * from hubloc where hubloc_hash like '%s'", + dbesc($r[0]['xchan_hash']) + ); + + if($s) { + foreach($s as $rr) + $o .= str_replace("\n","
",print_r($rr,true)) . EOL; + } + } } else notice( t('Not found.') . EOL); - $r = q("select * from hubloc where hubloc_hash like '%s%%'", - dbesc($addr) - ); - - if($r) { - foreach($r as $rr) - $o .= str_replace("\n","
",print_r($rr,true)) . EOL; - - } - - } return $o; } From 02fa970569dfd190ffa390b556a67fe51e95121a Mon Sep 17 00:00:00 2001 From: friendica Date: Wed, 17 Sep 2014 19:14:23 -0700 Subject: [PATCH 24/32] make the output a bit more readable --- mod/xchan.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/mod/xchan.php b/mod/xchan.php index a4dc70550..714603f6e 100644 --- a/mod/xchan.php +++ b/mod/xchan.php @@ -22,7 +22,7 @@ function xchan_content(&$a) { if($r) { foreach($r as $rr) { - $o .= str_replace("\n","
",print_r($rr,true)) . EOL; + $o .= str_replace(array("\n"," "),array("
"," "),print_r($rr,true)) . EOL; $s = q("select * from hubloc where hubloc_hash like '%s'", dbesc($r[0]['xchan_hash']) @@ -30,7 +30,7 @@ function xchan_content(&$a) { if($s) { foreach($s as $rr) - $o .= str_replace("\n","
",print_r($rr,true)) . EOL; + $o .= str_replace(array("\n"," "),array("
"," "),print_r($rr,true)) . EOL; } } } From eca420ec96912ad573354953297564c9f9ad2c32 Mon Sep 17 00:00:00 2001 From: friendica Date: Wed, 17 Sep 2014 19:46:55 -0700 Subject: [PATCH 25/32] defined several permission roles - these will probably require some review and adjustment. social social_restricted social_private forum forum_restricted forum_private feed feed_restricted soapbox --- include/permissions.php | 245 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 245 insertions(+) diff --git a/include/permissions.php b/include/permissions.php index 70c682cfc..0e213a208 100644 --- a/include/permissions.php +++ b/include/permissions.php @@ -465,6 +465,251 @@ function get_role_perms($role) { $ret['channel_w_like'] = PERMS_NETWORK; break; + + + case 'social_restricted': + $ret['perms_auto'] = false; + $ret['default_collection'] = true; + $ret['directory_publish'] = true; + $ret['perms_follow'] = PERMS_R_STREAM|PERMS_R_PROFILE|PERMS_R_PHOTOS|PERMS_R_ABOOK + |PERMS_W_STREAM|PERMS_W_WALL|PERMS_W_COMMENT|PERMS_W_MAIL|PERMS_W_CHAT + |PERMS_R_STORAGE|PERMS_R_PAGES|PERMS_W_LIKE; + $ret['perms_accept'] = PERMS_R_STREAM|PERMS_R_PROFILE|PERMS_R_PHOTOS|PERMS_R_ABOOK + |PERMS_W_STREAM|PERMS_W_WALL|PERMS_W_COMMENT|PERMS_W_MAIL|PERMS_W_CHAT + |PERMS_R_STORAGE|PERMS_R_PAGES|PERMS_W_LIKE; + $ret['channel_r_stream'] = PERMS_PUBLIC; + $ret['channel_r_profile'] = PERMS_PUBLIC; + $ret['channel_r_photos'] = PERMS_PUBLIC; + $ret['channel_r_abook'] = PERMS_PUBLIC; + $ret['channel_w_stream'] = PERMS_CONTACTS; + $ret['channel_w_wall'] = PERMS_CONTACTS; + $ret['channel_w_tagwall'] = PERMS_SPECIFIC; + $ret['channel_w_comment'] = PERMS_CONTACTS; + $ret['channel_w_mail'] = PERMS_CONTACTS; + $ret['channel_w_photos'] = 0; + $ret['channel_w_chat'] = PERMS_CONTACTS; + $ret['channel_a_delegate'] = 0; + $ret['channel_r_storage'] = PERMS_PUBLIC; + $ret['channel_r_pages'] = PERMS_PUBLIC; + $ret['channel_w_pages'] = 0; + $ret['channel_a_republish'] = PERMS_SPECIFIC; + $ret['channel_w_like'] = PERMS_CONTACTS; + + break; + + + case 'social_private': + $ret['perms_auto'] = false; + $ret['default_collection'] = true; + $ret['directory_publish'] = false; + $ret['perms_follow'] = PERMS_R_STREAM|PERMS_R_PROFILE|PERMS_R_PHOTOS|PERMS_R_ABOOK + |PERMS_W_STREAM|PERMS_W_WALL|PERMS_W_COMMENT|PERMS_W_MAIL|PERMS_W_CHAT + |PERMS_R_STORAGE|PERMS_R_PAGES|PERMS_W_LIKE; + $ret['perms_accept'] = PERMS_R_STREAM|PERMS_R_PROFILE|PERMS_R_PHOTOS|PERMS_R_ABOOK + |PERMS_W_STREAM|PERMS_W_WALL|PERMS_W_COMMENT|PERMS_W_MAIL|PERMS_W_CHAT + |PERMS_R_STORAGE|PERMS_R_PAGES|PERMS_W_LIKE; + $ret['channel_r_stream'] = PERMS_PUBLIC; + $ret['channel_r_profile'] = PERMS_PUBLIC; + $ret['channel_r_photos'] = PERMS_PUBLIC; + $ret['channel_r_abook'] = PERMS_CONTACTS; + $ret['channel_w_stream'] = PERMS_CONTACTS; + $ret['channel_w_wall'] = PERMS_CONTACTS; + $ret['channel_w_tagwall'] = PERMS_SPECIFIC; + $ret['channel_w_comment'] = PERMS_CONTACTS; + $ret['channel_w_mail'] = PERMS_SPECIFIC; + $ret['channel_w_photos'] = 0; + $ret['channel_w_chat'] = PERMS_SPECIFIC; + $ret['channel_a_delegate'] = 0; + $ret['channel_r_storage'] = PERMS_PUBLIC; + $ret['channel_r_pages'] = PERMS_PUBLIC; + $ret['channel_w_pages'] = 0; + $ret['channel_a_republish'] = PERMS_SPECIFIC; + $ret['channel_w_like'] = PERMS_CONTACTS; + + break; + + case 'forum_public': + $ret['perms_auto'] = true; + $ret['default_collection'] = false; + $ret['directory_publish'] = true; + $ret['perms_follow'] = PERMS_R_STREAM|PERMS_R_PROFILE|PERMS_R_PHOTOS|PERMS_R_ABOOK + |PERMS_W_STREAM|PERMS_W_WALL|PERMS_W_COMMENT|PERMS_W_MAIL|PERMS_W_CHAT + |PERMS_R_STORAGE|PERMS_R_PAGES|PERMS_A_REPUBLISH|PERMS_W_LIKE|PERMS_W_TAGWALL; + $ret['perms_accept'] = PERMS_R_STREAM|PERMS_R_PROFILE|PERMS_R_PHOTOS|PERMS_R_ABOOK + |PERMS_W_STREAM|PERMS_W_WALL|PERMS_W_COMMENT|PERMS_W_MAIL|PERMS_W_CHAT + |PERMS_R_STORAGE|PERMS_R_PAGES|PERMS_A_REPUBLISH|PERMS_W_LIKE|PERMS_W_TAGWALL; + $ret['channel_r_stream'] = PERMS_PUBLIC; + $ret['channel_r_profile'] = PERMS_PUBLIC; + $ret['channel_r_photos'] = PERMS_PUBLIC; + $ret['channel_r_abook'] = PERMS_PUBLIC; + $ret['channel_w_stream'] = PERMS_CONTACTS; + $ret['channel_w_wall'] = PERMS_CONTACTS; + $ret['channel_w_tagwall'] = PERMS_CONTACTS; + $ret['channel_w_comment'] = PERMS_CONTACTS; + $ret['channel_w_mail'] = PERMS_CONTACTS; + $ret['channel_w_photos'] = 0; + $ret['channel_w_chat'] = PERMS_CONTACTS; + $ret['channel_a_delegate'] = 0; + $ret['channel_r_storage'] = PERMS_PUBLIC; + $ret['channel_r_pages'] = PERMS_PUBLIC; + $ret['channel_w_pages'] = 0; + $ret['channel_a_republish'] = PERMS_SPECIFIC; + $ret['channel_w_like'] = PERMS_NETWORK; + + break; + + case 'forum_restricted': + $ret['perms_auto'] = false; + $ret['default_collection'] = true; + $ret['directory_publish'] = true; + $ret['perms_follow'] = PERMS_R_STREAM|PERMS_R_PROFILE|PERMS_R_PHOTOS|PERMS_R_ABOOK + |PERMS_W_STREAM|PERMS_W_WALL|PERMS_W_COMMENT|PERMS_W_MAIL|PERMS_W_CHAT + |PERMS_R_STORAGE|PERMS_R_PAGES|PERMS_W_LIKE|PERMS_W_TAGWALL; + $ret['perms_accept'] = PERMS_R_STREAM|PERMS_R_PROFILE|PERMS_R_PHOTOS|PERMS_R_ABOOK + |PERMS_W_STREAM|PERMS_W_WALL|PERMS_W_COMMENT|PERMS_W_MAIL|PERMS_W_CHAT + |PERMS_R_STORAGE|PERMS_R_PAGES|PERMS_W_LIKE|PERMS_W_TAGWALL; + $ret['channel_r_stream'] = PERMS_PUBLIC; + $ret['channel_r_profile'] = PERMS_PUBLIC; + $ret['channel_r_photos'] = PERMS_PUBLIC; + $ret['channel_r_abook'] = PERMS_PUBLIC; + $ret['channel_w_stream'] = PERMS_CONTACTS; + $ret['channel_w_wall'] = PERMS_CONTACTS; + $ret['channel_w_tagwall'] = PERMS_SPECIFIC; + $ret['channel_w_comment'] = PERMS_CONTACTS; + $ret['channel_w_mail'] = PERMS_CONTACTS; + $ret['channel_w_photos'] = 0; + $ret['channel_w_chat'] = PERMS_CONTACTS; + $ret['channel_a_delegate'] = 0; + $ret['channel_r_storage'] = PERMS_PUBLIC; + $ret['channel_r_pages'] = PERMS_PUBLIC; + $ret['channel_w_pages'] = 0; + $ret['channel_a_republish'] = PERMS_SPECIFIC; + $ret['channel_w_like'] = PERMS_CONTACTS; + + break; + + + case 'forum_private': + $ret['perms_auto'] = false; + $ret['default_collection'] = true; + $ret['directory_publish'] = false; + $ret['perms_follow'] = PERMS_R_STREAM|PERMS_R_PROFILE|PERMS_R_PHOTOS|PERMS_R_ABOOK + |PERMS_W_STREAM|PERMS_W_WALL|PERMS_W_COMMENT|PERMS_W_MAIL|PERMS_W_CHAT + |PERMS_R_STORAGE|PERMS_R_PAGES|PERMS_W_LIKE; + $ret['perms_accept'] = PERMS_R_STREAM|PERMS_R_PROFILE|PERMS_R_PHOTOS|PERMS_R_ABOOK + |PERMS_W_STREAM|PERMS_W_WALL|PERMS_W_COMMENT|PERMS_W_MAIL|PERMS_W_CHAT + |PERMS_R_STORAGE|PERMS_R_PAGES|PERMS_W_LIKE; + $ret['channel_r_stream'] = PERMS_PUBLIC; + $ret['channel_r_profile'] = PERMS_CONTACTS; + $ret['channel_r_photos'] = PERMS_CONTACTS; + $ret['channel_r_abook'] = PERMS_CONTACTS; + $ret['channel_w_stream'] = PERMS_CONTACTS; + $ret['channel_w_wall'] = PERMS_CONTACTS; + $ret['channel_w_tagwall'] = 0; + $ret['channel_w_comment'] = PERMS_CONTACTS; + $ret['channel_w_mail'] = PERMS_SPECIFIC; + $ret['channel_w_photos'] = 0; + $ret['channel_w_chat'] = PERMS_SPECIFIC; + $ret['channel_a_delegate'] = 0; + $ret['channel_r_storage'] = PERMS_CONTACTS; + $ret['channel_r_pages'] = PERMS_CONTACTS; + $ret['channel_w_pages'] = 0; + $ret['channel_a_republish'] = PERMS_SPECIFIC; + $ret['channel_w_like'] = PERMS_CONTACTS; + + break; + + case 'feed': + $ret['perms_auto'] = true; + $ret['default_collection'] = false; + $ret['directory_publish'] = true; + $ret['perms_follow'] = PERMS_R_STREAM|PERMS_R_PROFILE|PERMS_R_PHOTOS|PERMS_R_ABOOK + |PERMS_W_STREAM|PERMS_W_WALL|PERMS_W_COMMENT|PERMS_W_MAIL + |PERMS_R_STORAGE|PERMS_R_PAGES|PERMS_A_REPUBLISH|PERMS_W_LIKE; + $ret['perms_accept'] = PERMS_R_STREAM|PERMS_R_PROFILE|PERMS_R_PHOTOS|PERMS_R_ABOOK + |PERMS_W_STREAM|PERMS_W_WALL|PERMS_W_COMMENT|PERMS_W_MAIL + |PERMS_R_STORAGE|PERMS_R_PAGES|PERMS_A_REPUBLISH|PERMS_W_LIKE; + $ret['channel_r_stream'] = PERMS_PUBLIC; + $ret['channel_r_profile'] = PERMS_PUBLIC; + $ret['channel_r_photos'] = PERMS_PUBLIC; + $ret['channel_r_abook'] = PERMS_PUBLIC; + $ret['channel_w_stream'] = PERMS_CONTACTS; + $ret['channel_w_wall'] = PERMS_CONTACTS; + $ret['channel_w_tagwall'] = PERMS_SPECIFIC; + $ret['channel_w_comment'] = PERMS_CONTACTS; + $ret['channel_w_mail'] = PERMS_CONTACTS; + $ret['channel_w_photos'] = 0; + $ret['channel_w_chat'] = PERMS_CONTACTS; + $ret['channel_a_delegate'] = 0; + $ret['channel_r_storage'] = PERMS_PUBLIC; + $ret['channel_r_pages'] = PERMS_PUBLIC; + $ret['channel_w_pages'] = 0; + $ret['channel_a_republish'] = PERMS_NETWORK; + $ret['channel_w_like'] = PERMS_NETWORK; + + break; + + case 'feed_restricted': + + $ret['perms_auto'] = false; + $ret['default_collection'] = true; + $ret['directory_publish'] = false; + $ret['perms_follow'] = PERMS_R_STREAM|PERMS_R_PROFILE|PERMS_R_PHOTOS|PERMS_R_ABOOK + |PERMS_W_STREAM|PERMS_W_WALL|PERMS_W_COMMENT|PERMS_W_MAIL + |PERMS_R_STORAGE|PERMS_R_PAGES|PERMS_W_LIKE; + $ret['perms_accept'] = PERMS_R_STREAM|PERMS_R_PROFILE|PERMS_R_PHOTOS|PERMS_R_ABOOK + |PERMS_W_STREAM|PERMS_W_WALL|PERMS_W_COMMENT|PERMS_W_MAIL + |PERMS_R_STORAGE|PERMS_R_PAGES|PERMS_W_LIKE; + $ret['channel_r_stream'] = PERMS_PUBLIC; + $ret['channel_r_profile'] = PERMS_PUBLIC; + $ret['channel_r_photos'] = PERMS_PUBLIC; + $ret['channel_r_abook'] = PERMS_PUBLIC; + $ret['channel_w_stream'] = PERMS_CONTACTS; + $ret['channel_w_wall'] = PERMS_CONTACTS; + $ret['channel_w_tagwall'] = PERMS_SPECIFIC; + $ret['channel_w_comment'] = PERMS_CONTACTS; + $ret['channel_w_mail'] = PERMS_CONTACTS; + $ret['channel_w_photos'] = 0; + $ret['channel_w_chat'] = PERMS_CONTACTS; + $ret['channel_a_delegate'] = 0; + $ret['channel_r_storage'] = PERMS_PUBLIC; + $ret['channel_r_pages'] = PERMS_PUBLIC; + $ret['channel_w_pages'] = 0; + $ret['channel_a_republish'] = PERMS_SPECIFIC; + $ret['channel_w_like'] = PERMS_NETWORK; + + break; + + case 'soapbox': + $ret['perms_auto'] = true; + $ret['default_collection'] = false; + $ret['directory_publish'] = true; + $ret['perms_follow'] = PERMS_R_STREAM|PERMS_R_PROFILE|PERMS_R_PHOTOS|PERMS_R_ABOOK + |PERMS_R_STORAGE|PERMS_R_PAGES|PERMS_A_REPUBLISH|PERMS_W_LIKE; + $ret['perms_accept'] = PERMS_R_STREAM|PERMS_R_PROFILE|PERMS_R_PHOTOS|PERMS_R_ABOOK + |PERMS_R_STORAGE|PERMS_R_PAGES|PERMS_A_REPUBLISH|PERMS_W_LIKE; + $ret['channel_r_stream'] = PERMS_PUBLIC; + $ret['channel_r_profile'] = PERMS_PUBLIC; + $ret['channel_r_photos'] = PERMS_PUBLIC; + $ret['channel_r_abook'] = PERMS_PUBLIC; + $ret['channel_w_stream'] = 0; + $ret['channel_w_wall'] = 0; + $ret['channel_w_tagwall'] = 0; + $ret['channel_w_comment'] = 0; + $ret['channel_w_mail'] = 0; + $ret['channel_w_photos'] = 0; + $ret['channel_w_chat'] = 0; + $ret['channel_a_delegate'] = 0; + $ret['channel_r_storage'] = PERMS_PUBLIC; + $ret['channel_r_pages'] = PERMS_PUBLIC; + $ret['channel_w_pages'] = 0; + $ret['channel_a_republish'] = PERMS_SPECIFIC; + $ret['channel_w_like'] = PERMS_NETWORK; + + break; + + default: + break; } From 51d9f0d97a186e32aeacc42e3b2d2001d04b5dd2 Mon Sep 17 00:00:00 2001 From: friendica Date: Wed, 17 Sep 2014 21:16:15 -0700 Subject: [PATCH 26/32] channel permission roles --- include/identity.php | 10 +++++----- include/permissions.php | 27 ++++++++++++++++++++++++++- mod/new_channel.php | 7 ++++++- view/css/mod_new_channel.css | 4 ++-- view/tpl/new_channel.tpl | 7 +++++++ 5 files changed, 46 insertions(+), 9 deletions(-) diff --git a/include/identity.php b/include/identity.php index 38e96ab71..ead785543 100644 --- a/include/identity.php +++ b/include/identity.php @@ -219,13 +219,15 @@ function create_identity($arr) { $perms_sql = ''; $role_permissions = null; + $global_perms = get_perms(); if(array_key_exists('permissions_role',$arr) && $arr['permissions_role']) { $role_permissions = get_role_perms($arr['permissions_role']); + if($role_permissions) { foreach($role_permissions as $p => $v) { if(strpos($p,'channel_') !== false) { - $perms_keys .= ', ' . $global_perms[$p][0]; + $perms_keys .= ', ' . $p; $perms_vals .= ', ' . intval($v); } if($p === 'directory_publish') @@ -235,16 +237,16 @@ function create_identity($arr) { } else { $defperms = site_default_perms(); - $global_perms = get_perms(); foreach($defperms as $p => $v) { $perms_keys .= ', ' . $global_perms[$p][0]; $perms_vals .= ', ' . intval($v); } } + $expire = get_config('system', 'default_expire_days'); $expire = (($expire===false)? '0': $expire); - + $r = q("insert into channel ( channel_account_id, channel_primary, channel_name, channel_address, channel_guid, channel_guid_sig, channel_hash, channel_prvkey, channel_pubkey, channel_pageflags, channel_expire_days $perms_keys ) @@ -264,8 +266,6 @@ function create_identity($arr) { ); - - $r = q("select * from channel where channel_account_id = %d and channel_guid = '%s' limit 1", intval($arr['account_id']), diff --git a/include/permissions.php b/include/permissions.php index 0e213a208..932ae897b 100644 --- a/include/permissions.php +++ b/include/permissions.php @@ -528,7 +528,7 @@ function get_role_perms($role) { break; - case 'forum_public': + case 'forum': $ret['perms_auto'] = true; $ret['default_collection'] = false; $ret['directory_publish'] = true; @@ -719,3 +719,28 @@ function get_role_perms($role) { } +function role_selector($current) { + $roles = array( + 'social' => array( t('Social Networking'), + array('social' => t('Mostly Public'), 'social_restricted' => t('Restricted'), 'social_private' => t('Private'))), + 'forum' => array( t('Community Forum'), + array('forum' => t('Mostly Public'), 'forum_restricted' => t('Restricted'), 'forum_private' => t('Private'))), + 'feed' => array( t('Feed Republish'), + array('feed' => t('Mostly Public'), 'feed_restricted' => t('Restricted'))), + 'soapbox' => array( t('Celebrity/Soapbox'), + array('soapbox' => t('Mostly Public'))), + 'other' => array( t('Other'), + array('custom' => t('Custom/Expert Mode')))); + $o = ''; + return $o; +} + diff --git a/mod/new_channel.php b/mod/new_channel.php index eafef2c08..e70c64f23 100644 --- a/mod/new_channel.php +++ b/mod/new_channel.php @@ -1,6 +1,8 @@ t('Your nickname will be used to create an easily remembered channel address (like an email address) which you can share with others.'), '$label_import' => t('Or import an existing channel from another location'), '$name' => $name, + '$label_role' => t('Channel Type'), + '$help_role' => t('Please choose a channel role (such as social networking or community forum) and privacy requirements so we can select the best permissions for you'), + '$role_select' => role_selector(($privacy_role) ? $privacy_role : 'social'), '$nickname' => $nickname, '$submit' => t('Create') )); diff --git a/view/css/mod_new_channel.css b/view/css/mod_new_channel.css index 3b9c80953..2af0fbb2d 100644 --- a/view/css/mod_new_channel.css +++ b/view/css/mod_new_channel.css @@ -1,13 +1,13 @@ h2 { margin-left: 15%; - margin-top: 15%; + margin-top: 5%; } #newchannel-form { font-size: 1.4em; margin-left: 15%; - margin-top: 5%; + margin-top: 20px; width: 50%; } diff --git a/view/tpl/new_channel.tpl b/view/tpl/new_channel.tpl index 261f965da..b6562f707 100755 --- a/view/tpl/new_channel.tpl +++ b/view/tpl/new_channel.tpl @@ -4,6 +4,13 @@
{{$desc}}
+
{{$help_role}}
+ + + {{$role_select}} +
+ + From 22aa5aca14cce46727e15bd061cb6900a21b46b8 Mon Sep 17 00:00:00 2001 From: friendica Date: Wed, 17 Sep 2014 21:27:02 -0700 Subject: [PATCH 27/32] add a spinner or two to the new channel page so folks have a clue that we're doing something in the background - trying to complete the nick field for them (and then check it before they submit). --- view/js/mod_new_channel.js | 4 ++++ view/tpl/new_channel.tpl | 2 ++ 2 files changed, 6 insertions(+) diff --git a/view/js/mod_new_channel.js b/view/js/mod_new_channel.js index a3c1dd05c..882da940e 100644 --- a/view/js/mod_new_channel.js +++ b/view/js/mod_new_channel.js @@ -1,16 +1,20 @@ $(document).ready(function() { $("#newchannel-name").blur(function() { + $("#name-spinner").spin('small'); var zreg_name = $("#newchannel-name").val(); $.get("new_channel/autofill.json?f=&name=" + encodeURIComponent(zreg_name),function(data) { $("#newchannel-nickname").val(data); zFormError("#newchannel-name-feedback",data.error); + $("#name-spinner").spin(false); }); }); $("#newchannel-nickname").blur(function() { + $("#nick-spinner").spin('small'); var zreg_nick = $("#newchannel-nickname").val(); $.get("new_channel/checkaddr.json?f=&nick=" + encodeURIComponent(zreg_nick),function(data) { $("#newchannel-nickname").val(data); zFormError("#newchannel-nickname-feedback",data.error); + $("#nick-spinner").spin(false); }); }); diff --git a/view/tpl/new_channel.tpl b/view/tpl/new_channel.tpl index b6562f707..b28810236 100755 --- a/view/tpl/new_channel.tpl +++ b/view/tpl/new_channel.tpl @@ -13,6 +13,7 @@ +
@@ -20,6 +21,7 @@ +
From c6062d7872e832c06ebc55fd249d1dacf0e264d1 Mon Sep 17 00:00:00 2001 From: friendica Date: Wed, 17 Sep 2014 21:52:30 -0700 Subject: [PATCH 28/32] usability tweaks --- include/identity.php | 8 ++++++-- include/permissions.php | 9 +++++++++ 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/include/identity.php b/include/identity.php index ead785543..50c5d13b9 100644 --- a/include/identity.php +++ b/include/identity.php @@ -361,14 +361,18 @@ function create_identity($arr) { // Save our permissions role so we can perhaps call it up and modify it later. - if($role_permissions) + if($role_permissions) { set_pconfig($newuid,'system','permissions_role',$arr['permissions_role']); + if(array_key_exists('online',$role_permissions)) + set_pconfig('system','hide_presence',1-intval($role_permissions['online'])); + } - // Create a group with no members. This allows somebody to use it + // Create a group with yourself as a member. This allows somebody to use it // right away as a default group for new contacts. require_once('include/group.php'); group_add($newuid, t('Friends')); + group_add_member($newuid,t('Friends'),$ret['channel']['channel_hash']); // if our role_permissions indicate that we're using a default collection ACL, add it. diff --git a/include/permissions.php b/include/permissions.php index 932ae897b..e25052f95 100644 --- a/include/permissions.php +++ b/include/permissions.php @@ -440,6 +440,7 @@ function get_role_perms($role) { $ret['perms_auto'] = false; $ret['default_collection'] = false; $ret['directory_publish'] = true; + $ret['online'] = true; $ret['perms_follow'] = PERMS_R_STREAM|PERMS_R_PROFILE|PERMS_R_PHOTOS|PERMS_R_ABOOK |PERMS_W_STREAM|PERMS_W_WALL|PERMS_W_COMMENT|PERMS_W_MAIL|PERMS_W_CHAT |PERMS_R_STORAGE|PERMS_R_PAGES|PERMS_A_REPUBLISH|PERMS_W_LIKE; @@ -471,6 +472,7 @@ function get_role_perms($role) { $ret['perms_auto'] = false; $ret['default_collection'] = true; $ret['directory_publish'] = true; + $ret['online'] = true; $ret['perms_follow'] = PERMS_R_STREAM|PERMS_R_PROFILE|PERMS_R_PHOTOS|PERMS_R_ABOOK |PERMS_W_STREAM|PERMS_W_WALL|PERMS_W_COMMENT|PERMS_W_MAIL|PERMS_W_CHAT |PERMS_R_STORAGE|PERMS_R_PAGES|PERMS_W_LIKE; @@ -502,6 +504,7 @@ function get_role_perms($role) { $ret['perms_auto'] = false; $ret['default_collection'] = true; $ret['directory_publish'] = false; + $ret['online'] = false; $ret['perms_follow'] = PERMS_R_STREAM|PERMS_R_PROFILE|PERMS_R_PHOTOS|PERMS_R_ABOOK |PERMS_W_STREAM|PERMS_W_WALL|PERMS_W_COMMENT|PERMS_W_MAIL|PERMS_W_CHAT |PERMS_R_STORAGE|PERMS_R_PAGES|PERMS_W_LIKE; @@ -532,6 +535,7 @@ function get_role_perms($role) { $ret['perms_auto'] = true; $ret['default_collection'] = false; $ret['directory_publish'] = true; + $ret['online'] = false; $ret['perms_follow'] = PERMS_R_STREAM|PERMS_R_PROFILE|PERMS_R_PHOTOS|PERMS_R_ABOOK |PERMS_W_STREAM|PERMS_W_WALL|PERMS_W_COMMENT|PERMS_W_MAIL|PERMS_W_CHAT |PERMS_R_STORAGE|PERMS_R_PAGES|PERMS_A_REPUBLISH|PERMS_W_LIKE|PERMS_W_TAGWALL; @@ -562,6 +566,7 @@ function get_role_perms($role) { $ret['perms_auto'] = false; $ret['default_collection'] = true; $ret['directory_publish'] = true; + $ret['online'] = false; $ret['perms_follow'] = PERMS_R_STREAM|PERMS_R_PROFILE|PERMS_R_PHOTOS|PERMS_R_ABOOK |PERMS_W_STREAM|PERMS_W_WALL|PERMS_W_COMMENT|PERMS_W_MAIL|PERMS_W_CHAT |PERMS_R_STORAGE|PERMS_R_PAGES|PERMS_W_LIKE|PERMS_W_TAGWALL; @@ -593,6 +598,7 @@ function get_role_perms($role) { $ret['perms_auto'] = false; $ret['default_collection'] = true; $ret['directory_publish'] = false; + $ret['online'] = false; $ret['perms_follow'] = PERMS_R_STREAM|PERMS_R_PROFILE|PERMS_R_PHOTOS|PERMS_R_ABOOK |PERMS_W_STREAM|PERMS_W_WALL|PERMS_W_COMMENT|PERMS_W_MAIL|PERMS_W_CHAT |PERMS_R_STORAGE|PERMS_R_PAGES|PERMS_W_LIKE; @@ -623,6 +629,7 @@ function get_role_perms($role) { $ret['perms_auto'] = true; $ret['default_collection'] = false; $ret['directory_publish'] = true; + $ret['online'] = false; $ret['perms_follow'] = PERMS_R_STREAM|PERMS_R_PROFILE|PERMS_R_PHOTOS|PERMS_R_ABOOK |PERMS_W_STREAM|PERMS_W_WALL|PERMS_W_COMMENT|PERMS_W_MAIL |PERMS_R_STORAGE|PERMS_R_PAGES|PERMS_A_REPUBLISH|PERMS_W_LIKE; @@ -654,6 +661,7 @@ function get_role_perms($role) { $ret['perms_auto'] = false; $ret['default_collection'] = true; $ret['directory_publish'] = false; + $ret['online'] = false; $ret['perms_follow'] = PERMS_R_STREAM|PERMS_R_PROFILE|PERMS_R_PHOTOS|PERMS_R_ABOOK |PERMS_W_STREAM|PERMS_W_WALL|PERMS_W_COMMENT|PERMS_W_MAIL |PERMS_R_STORAGE|PERMS_R_PAGES|PERMS_W_LIKE; @@ -684,6 +692,7 @@ function get_role_perms($role) { $ret['perms_auto'] = true; $ret['default_collection'] = false; $ret['directory_publish'] = true; + $ret['online'] = false; $ret['perms_follow'] = PERMS_R_STREAM|PERMS_R_PROFILE|PERMS_R_PHOTOS|PERMS_R_ABOOK |PERMS_R_STORAGE|PERMS_R_PAGES|PERMS_A_REPUBLISH|PERMS_W_LIKE; $ret['perms_accept'] = PERMS_R_STREAM|PERMS_R_PROFILE|PERMS_R_PHOTOS|PERMS_R_ABOOK From 71672083450a8d5923c1839a1c766033203b3771 Mon Sep 17 00:00:00 2001 From: friendica Date: Wed, 17 Sep 2014 22:30:25 -0700 Subject: [PATCH 29/32] forgot this one... --- doc/to_do_code.bb | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/to_do_code.bb b/doc/to_do_code.bb index 0005b4be3..fe213baf3 100644 --- a/doc/to_do_code.bb +++ b/doc/to_do_code.bb @@ -14,6 +14,8 @@ We need much more than this, but here are areas where developers can help. Pleas [li]implement oembed provider interface[/li] +[li]refactor the oembed client interface so that we can safely sandbox remote content[/li] + [li]implement openid server interface[/li] [li]Write more webpage layouts[/li] From 8eb21cceb3a8274d8727073d03b8093f467ec852 Mon Sep 17 00:00:00 2001 From: friendica Date: Wed, 17 Sep 2014 22:53:38 -0700 Subject: [PATCH 30/32] use 24-hour clock for non-American dates --- view/en-gb/strings.php | 2 ++ 1 file changed, 2 insertions(+) diff --git a/view/en-gb/strings.php b/view/en-gb/strings.php index abf14f43a..358c90d36 100644 --- a/view/en-gb/strings.php +++ b/view/en-gb/strings.php @@ -27,3 +27,5 @@ $a->strings["Do you want to authorize this application to access your posts and $a->strings["If your certificate is not recognized, members of other sites (who may themselves have valid certificates) will get a warning message on their own site complaining about security issues."] = "If your certificate is not recognised, members of other sites (who may themselves have valid certificates) will get a warning message on their own site complaining about security issues."; $a->strings["This is a hub of the Red Matrix - a global cooperative network of decentralized privacy enhanced websites."] = "This is a hub of the Red Matrix - a global cooperative network of decentralised privacy enhanced websites."; $a->strings["You are cordially invited to join me and some other close friends on the Red Matrix - a revolutionary new decentralized communication and information tool."] = "You are cordially invited to join me and some other close friends on the Red Matrix - a revolutionary new decentralised communication and information tool."; +$a->strings["l F d, Y \\@ g:i A"] = "l j F, Y \\@ G:i"; +$a->strings["D, d M Y - g:i A"] = "D, d M Y - G:i"]; From 0deb592cb5a6562f36a2f52025a71d3a20fcae42 Mon Sep 17 00:00:00 2001 From: friendica Date: Wed, 17 Sep 2014 22:55:27 -0700 Subject: [PATCH 31/32] typo --- view/en-gb/strings.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/view/en-gb/strings.php b/view/en-gb/strings.php index 358c90d36..a95915844 100644 --- a/view/en-gb/strings.php +++ b/view/en-gb/strings.php @@ -28,4 +28,4 @@ $a->strings["If your certificate is not recognized, members of other sites (who $a->strings["This is a hub of the Red Matrix - a global cooperative network of decentralized privacy enhanced websites."] = "This is a hub of the Red Matrix - a global cooperative network of decentralised privacy enhanced websites."; $a->strings["You are cordially invited to join me and some other close friends on the Red Matrix - a revolutionary new decentralized communication and information tool."] = "You are cordially invited to join me and some other close friends on the Red Matrix - a revolutionary new decentralised communication and information tool."; $a->strings["l F d, Y \\@ g:i A"] = "l j F, Y \\@ G:i"; -$a->strings["D, d M Y - g:i A"] = "D, d M Y - G:i"]; +$a->strings["D, d M Y - g:i A"] = "D, d M Y - G:i"; From 0b47fb9a91b58147e616ea75a23dea0d431c40f8 Mon Sep 17 00:00:00 2001 From: friendica Date: Wed, 17 Sep 2014 22:59:56 -0700 Subject: [PATCH 32/32] keep the language consistent --- mod/new_channel.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mod/new_channel.php b/mod/new_channel.php index e70c64f23..8329f0ec3 100644 --- a/mod/new_channel.php +++ b/mod/new_channel.php @@ -116,7 +116,7 @@ function new_channel_content(&$a) { '$label_import' => t('Or import an existing channel from another location'), '$name' => $name, '$label_role' => t('Channel Type'), - '$help_role' => t('Please choose a channel role (such as social networking or community forum) and privacy requirements so we can select the best permissions for you'), + '$help_role' => t('Please choose a channel type (such as social networking or community forum) and privacy requirements so we can select the best permissions for you'), '$role_select' => role_selector(($privacy_role) ? $privacy_role : 'social'), '$nickname' => $nickname, '$submit' => t('Create')