From 2a7b73a5f57e40ea29d3e1c0cd8a0d71d254070d Mon Sep 17 00:00:00 2001 From: brentil Date: Tue, 23 Nov 2010 22:50:11 -0500 Subject: [PATCH 01/17] ModuleUpdates v4.0 beta, uses installed version information to dynamically determine git location. gallery::VERSION info is wrong though --- .../controllers/admin_moduleupdates.php | 13 +++++++------ .../moduleupdates/helpers/moduleupdates_event.php | 2 +- .../helpers/moduleupdates_installer.php | 6 +++--- 3.0/modules/moduleupdates/module.info | 2 +- .../views/admin_moduleupdates.html.php | 6 +++--- 5 files changed, 15 insertions(+), 14 deletions(-) diff --git a/3.0/modules/moduleupdates/controllers/admin_moduleupdates.php b/3.0/modules/moduleupdates/controllers/admin_moduleupdates.php index 921cf535..df6ca12d 100755 --- a/3.0/modules/moduleupdates/controllers/admin_moduleupdates.php +++ b/3.0/modules/moduleupdates/controllers/admin_moduleupdates.php @@ -45,10 +45,10 @@ class Admin_Moduleupdates_Controller extends Admin_Controller { $view->content = new View("admin_moduleupdates.html"); $devDebug = false; - $refreshCache = false; + $refreshCache = false; $cache = unserialize(Cache::instance()->get("moduleupdates_cache")); - $cache_updates = unserialize(Cache::instance()->get("moduleupdates_cache_updates")); + $cache_updates = unserialize(Cache::instance()->get("moduleupdates_cache_updates")); //--------------------------------------------------------------------------------------------- //echo 'Message 01: ' .$cache_updates . '
'; @@ -167,6 +167,7 @@ class Admin_Moduleupdates_Controller extends Admin_Controller { $view->content->csrf = access::csrf_token(); $view->content->Google = $Google; $view->content->GitHub = $GitHub; + $view->content->Gallery_Version = gallery::VERSION; print $view; @@ -197,7 +198,7 @@ class Admin_Moduleupdates_Controller extends Admin_Controller { if ($devDebug == true){ if ($file == null) { try { - $file = fopen ("http://github.com/brentil/gallery3-contrib/raw/master/3.0/modules/".$module_name."/module.info", "r"); + $file = fopen ("http://github.com/brentil/gallery3-contrib/raw/master/". gallery::VERSION ."/modules/".$module_name."/module.info", "r"); if ($file != null) { $server = '(brentil)'; } @@ -213,7 +214,7 @@ class Admin_Moduleupdates_Controller extends Admin_Controller { try { $file = fopen ("http://github.com/gallery/gallery3/raw/master/modules/".$module_name."/module.info", "r"); if ($file != null) { - $server = '(G3)'; + $server = '(G)'; } } catch (Exception $e) { @@ -224,9 +225,9 @@ class Admin_Moduleupdates_Controller extends Admin_Controller { //Check the Gallery3 Community Contributions GitHub if ($file == null) { try { - $file = fopen ("http://github.com/gallery/gallery3-contrib/raw/master/3.0/modules/".$module_name."/module.info", "r"); + $file = fopen ("http://github.com/gallery/gallery3-contrib/raw/master/". gallery::VERSION ."/modules/".$module_name."/module.info", "r"); if ($file != null) { - $server = '(G3CC)'; + $server = '(GCC)'; } } catch (Exception $e) { diff --git a/3.0/modules/moduleupdates/helpers/moduleupdates_event.php b/3.0/modules/moduleupdates/helpers/moduleupdates_event.php index dd6efc9c..8dbed46c 100644 --- a/3.0/modules/moduleupdates/helpers/moduleupdates_event.php +++ b/3.0/modules/moduleupdates/helpers/moduleupdates_event.php @@ -27,4 +27,4 @@ class moduleupdates_event_Core { ->label(t("Module Updates")) ->url(url::site("admin/moduleupdates"))); } -} \ No newline at end of file +} diff --git a/3.0/modules/moduleupdates/helpers/moduleupdates_installer.php b/3.0/modules/moduleupdates/helpers/moduleupdates_installer.php index dd0dddb8..39d1dcc0 100644 --- a/3.0/modules/moduleupdates/helpers/moduleupdates_installer.php +++ b/3.0/modules/moduleupdates/helpers/moduleupdates_installer.php @@ -24,7 +24,7 @@ class moduleupdates_installer { $version = module::get_version("moduleupdates"); if ($version == 0) { - module::set_version("moduleupdates", 2); + module::set_version("moduleupdates", 4); //Remove the ModuleUpdates cache entry 'JIC' Cache::instance()->delete("ModuleUpdates"); //create the blank ModuleUpdates cache entry with an expiration of 0 days @@ -34,7 +34,7 @@ class moduleupdates_installer { } static function upgrade($version) { - module::set_version("moduleupdates", 2); + module::set_version("moduleupdates", 4); //Remove the ModuleUpdates cache entry 'JIC' Cache::instance()->delete("ModuleUpdates"); //Empty the ModuleUpdates cache entry so our new version starts from scratch @@ -48,4 +48,4 @@ class moduleupdates_installer { Cache::instance()->delete("ModuleUpdates"); module::delete("moduleupdates"); } -} +} \ No newline at end of file diff --git a/3.0/modules/moduleupdates/module.info b/3.0/modules/moduleupdates/module.info index cf43770b..722abecc 100755 --- a/3.0/modules/moduleupdates/module.info +++ b/3.0/modules/moduleupdates/module.info @@ -1,3 +1,3 @@ name = "Module Updates" description = "Compares your installed module version against the ones stored in the GitHub." -version = 3 +version = 4 \ No newline at end of file diff --git a/3.0/modules/moduleupdates/views/admin_moduleupdates.html.php b/3.0/modules/moduleupdates/views/admin_moduleupdates.html.php index 3fdc06a7..3d7d5453 100644 --- a/3.0/modules/moduleupdates/views/admin_moduleupdates.html.php +++ b/3.0/modules/moduleupdates/views/admin_moduleupdates.html.php @@ -2,7 +2,7 @@
-

+

@@ -25,7 +25,7 @@
    -
    • +
@@ -45,4 +45,4 @@
-
\ No newline at end of file + From 791799a09638cac0dafe70163381c5aa3a064ace Mon Sep 17 00:00:00 2001 From: brentil Date: Tue, 23 Nov 2010 23:57:14 -0500 Subject: [PATCH 02/17] MU v4.0 final. Added a hack for now to convert gallery::VERSION into the information needed. --- .../moduleupdates/controllers/admin_moduleupdates.php | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/3.0/modules/moduleupdates/controllers/admin_moduleupdates.php b/3.0/modules/moduleupdates/controllers/admin_moduleupdates.php index df6ca12d..b1274111 100755 --- a/3.0/modules/moduleupdates/controllers/admin_moduleupdates.php +++ b/3.0/modules/moduleupdates/controllers/admin_moduleupdates.php @@ -167,7 +167,7 @@ class Admin_Moduleupdates_Controller extends Admin_Controller { $view->content->csrf = access::csrf_token(); $view->content->Google = $Google; $view->content->GitHub = $GitHub; - $view->content->Gallery_Version = gallery::VERSION; + $view->content->Gallery_Version = substr_replace(gallery::VERSION,"",strpos(gallery::VERSION," ")); print $view; @@ -198,7 +198,7 @@ class Admin_Moduleupdates_Controller extends Admin_Controller { if ($devDebug == true){ if ($file == null) { try { - $file = fopen ("http://github.com/brentil/gallery3-contrib/raw/master/". gallery::VERSION ."/modules/".$module_name."/module.info", "r"); + $file = fopen ("http://github.com/brentil/gallery3-contrib/raw/master/". substr_replace(gallery::VERSION,"",strpos(gallery::VERSION," ")) ."/modules/".$module_name."/module.info", "r"); if ($file != null) { $server = '(brentil)'; } @@ -225,7 +225,7 @@ class Admin_Moduleupdates_Controller extends Admin_Controller { //Check the Gallery3 Community Contributions GitHub if ($file == null) { try { - $file = fopen ("http://github.com/gallery/gallery3-contrib/raw/master/". gallery::VERSION ."/modules/".$module_name."/module.info", "r"); + $file = fopen ("http://github.com/gallery/gallery3-contrib/raw/master/". substr_replace(gallery::VERSION,"",strpos(gallery::VERSION," ")) ."/modules/".$module_name."/module.info", "r"); if ($file != null) { $server = '(GCC)'; } From 0eb7d3d950fed405ea9a30509b91d6440c12180d Mon Sep 17 00:00:00 2001 From: sykong Date: Sun, 19 Dec 2010 04:59:50 -0800 Subject: [PATCH 03/17] Modified to handle large albums. Now, the module will only tag 50 at a time and continue automatically. If it is still too much, and it "stops", there will also be a "continue" link to allow resuming. The continue link will also adjust the maximum number of tags at a time (from the default 50) to the current number where batchtag "stops". --- 3.0/modules/batchtag/controllers/batchtag.php | 85 +++++++++++++++---- 1 file changed, 68 insertions(+), 17 deletions(-) diff --git a/3.0/modules/batchtag/controllers/batchtag.php b/3.0/modules/batchtag/controllers/batchtag.php index ec012719..bbfb3ea1 100644 --- a/3.0/modules/batchtag/controllers/batchtag.php +++ b/3.0/modules/batchtag/controllers/batchtag.php @@ -25,42 +25,93 @@ class BatchTag_Controller extends Controller { access::verify_csrf(); $input = Input::instance(); + url::redirect(url::abs_site("batchtag/tagitems2?name={$input->post('name')}&item_id={$input->post('item_id')}&tag_subitems={$input->post('tag_subitems')}&csrf={$input->post('csrf')}")); + } + + public function tagitems2() { + // Tag all non-album items in the current album with the specified tags. + + // Prevent Cross Site Request Forgery + access::verify_csrf(); + + $input = Input::instance(); + + // Variables + if (($input->get("batchtag_max") == false) || ($input->get("batchtag_max") == "0")) { + $batchtag_max = "50"; + } else { + $batchtag_max = $input->get("batchtag_max"); + } + if ($input->get("batchtag_items_processed") == false) { + $batchtag_items_processed = "0"; + } else { + $batchtag_items_processed = $input->get("batchtag_items_processed"); + } + // Figure out if the contents of sub-albums should also be tagged - $str_tag_subitems = $input->post("tag_subitems"); + $str_tag_subitems = $input->get("tag_subitems"); $children = ""; if ($str_tag_subitems == false) { // Generate an array of all non-album items in the current album. $children = ORM::factory("item") - ->where("parent_id", "=", $input->post("item_id")) + ->where("parent_id", "=", $input->get("item_id")) ->where("type", "!=", "album") ->find_all(); } else { // Generate an array of all non-album items in the current album // and any sub albums. - $item = ORM::factory("item", $input->post("item_id")); + $item = ORM::factory("item", $input->get("item_id")); $children = $item->descendants(); } + // Loop through each item in the album and make sure the user has // access to view and edit it. - foreach ($children as $child) { - if (access::can("view", $child) && access::can("edit", $child) && !$child->is_album()) { + $children_count = "0"; + $tag_count = "0"; - // Assuming the user can view/edit the current item, loop - // through each tag that was submitted and apply it to - // the current item. - foreach (explode(",", $input->post("name")) as $tag_name) { - $tag_name = trim($tag_name); - if ($tag_name) { - tag::add($child, $tag_name); + //echo Kohana::debug($children); + + echo ''; + + foreach ($children as $child) { + + if ($tag_count < $batchtag_max) { + + if ($children_count >= $batchtag_items_processed) { + if (access::can("view", $child) && access::can("edit", $child) && !$child->is_album()) { + + // Assuming the user can view/edit the current item, loop + // through each tag that was submitted and apply it to + // the current item. + foreach (explode(",", $input->get("name")) as $tag_name) { + $tag_name = trim($tag_name); + if ($tag_name) { + tag::add($child, $tag_name); + } + // $tag_count should be inside the foreach loop as it is depending on the number of time tag:add is run + $tag_count++; + } } - } - } + echo '' . "\n"; + $children_count++; + $batchtag_max_new = $tag_count; + echo '
get('name')}&item_id={$input->get('item_id')}&tag_subitems={$input->get('tag_subitems')}&batchtag_items_processed=$children_count&batchtag_max=$batchtag_max_new&csrf={$input->get('csrf')}") . '">Continue
'; + } else { $children_count++; } + + } else { break; } + } - // Redirect back to the album. - $item = ORM::factory("item", $input->post("item_id")); - url::redirect(url::abs_site("{$item->type}s/{$item->id}")); + if ($tag_count < $batchtag_max) { + // Redirect back to the album. + $item = ORM::factory("item", $input->get("item_id")); + url::redirect(url::abs_site("{$item->type}s/{$item->id}")); + //echo url::abs_site("{$item->type}s/{$item->id}"); + } else { + url::redirect(url::abs_site("batchtag/tagitems2?name={$input->get('name')}&item_id={$input->get('item_id')}&tag_subitems={$input->get('tag_subitems')}&batchtag_items_processed=$children_count&batchtag_max=$batchtag_max&csrf={$input->get('csrf')}")); + //echo url::abs_site("batchtag/tagitems2?name={$input->get('name')}&item_id={$input->get('item_id')}&tag_subitems={$input->get('tag_subitems')}&batchtag_items_processed=$children_count&batchtag_max=$batchtag_max&csrf={$input->get('csrf')}"); + } } } From 9267491ab2587b2d2e72dc55cb77a7de254ee748 Mon Sep 17 00:00:00 2001 From: Jay Deiman Date: Mon, 20 Dec 2010 14:18:34 -0600 Subject: [PATCH 04/17] Added pylibgal3 submodule --- .gitmodules | 3 +++ 3.0/client/Python/pylibgal3 | 1 + 2 files changed, 4 insertions(+) create mode 100644 .gitmodules create mode 160000 3.0/client/Python/pylibgal3 diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 00000000..e6646cbd --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "3.0/client/Python/pylibgal3"] + path = 3.0/client/Python/pylibgal3 + url = git://github.com/crustymonkey/pylibgal3.git diff --git a/3.0/client/Python/pylibgal3 b/3.0/client/Python/pylibgal3 new file mode 160000 index 00000000..233b5802 --- /dev/null +++ b/3.0/client/Python/pylibgal3 @@ -0,0 +1 @@ +Subproject commit 233b5802cd6f2c466bab74fd82bacf6b0cdef681 From 2a80225313b628797566b66016fea5e0aa54ef4f Mon Sep 17 00:00:00 2001 From: Jay Deiman Date: Tue, 21 Dec 2010 11:42:39 -0600 Subject: [PATCH 05/17] Removed the submodule pylibgal3 --- .gitmodules | 3 --- 3.0/client/Python/pylibgal3 | 1 - 2 files changed, 4 deletions(-) delete mode 100644 .gitmodules delete mode 160000 3.0/client/Python/pylibgal3 diff --git a/.gitmodules b/.gitmodules deleted file mode 100644 index e6646cbd..00000000 --- a/.gitmodules +++ /dev/null @@ -1,3 +0,0 @@ -[submodule "3.0/client/Python/pylibgal3"] - path = 3.0/client/Python/pylibgal3 - url = git://github.com/crustymonkey/pylibgal3.git diff --git a/3.0/client/Python/pylibgal3 b/3.0/client/Python/pylibgal3 deleted file mode 160000 index 233b5802..00000000 --- a/3.0/client/Python/pylibgal3 +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 233b5802cd6f2c466bab74fd82bacf6b0cdef681 From f1deeecc543e1b8621f7244e9503864d611815e5 Mon Sep 17 00:00:00 2001 From: Jay Deiman Date: Tue, 21 Dec 2010 11:45:11 -0600 Subject: [PATCH 06/17] Adding the pylibgal3 source --- 3.0/client/Python/pylibgal3/.gitignore | 4 + 3.0/client/Python/pylibgal3/KNOWN_ISSUES | 13 + 3.0/client/Python/pylibgal3/LICENSE | 674 ++++++++++++++++++ 3.0/client/Python/pylibgal3/MANIFEST.in | 2 + 3.0/client/Python/pylibgal3/README | 21 + 3.0/client/Python/pylibgal3/libg3/Errors.py | 51 ++ 3.0/client/Python/pylibgal3/libg3/G3Items.py | 469 ++++++++++++ 3.0/client/Python/pylibgal3/libg3/Gallery3.py | 454 ++++++++++++ 3.0/client/Python/pylibgal3/libg3/Requests.py | 72 ++ 3.0/client/Python/pylibgal3/libg3/__init__.py | 24 + 3.0/client/Python/pylibgal3/setup.py | 36 + 11 files changed, 1820 insertions(+) create mode 100644 3.0/client/Python/pylibgal3/.gitignore create mode 100644 3.0/client/Python/pylibgal3/KNOWN_ISSUES create mode 100644 3.0/client/Python/pylibgal3/LICENSE create mode 100644 3.0/client/Python/pylibgal3/MANIFEST.in create mode 100644 3.0/client/Python/pylibgal3/README create mode 100644 3.0/client/Python/pylibgal3/libg3/Errors.py create mode 100644 3.0/client/Python/pylibgal3/libg3/G3Items.py create mode 100644 3.0/client/Python/pylibgal3/libg3/Gallery3.py create mode 100644 3.0/client/Python/pylibgal3/libg3/Requests.py create mode 100644 3.0/client/Python/pylibgal3/libg3/__init__.py create mode 100644 3.0/client/Python/pylibgal3/setup.py diff --git a/3.0/client/Python/pylibgal3/.gitignore b/3.0/client/Python/pylibgal3/.gitignore new file mode 100644 index 00000000..26cad680 --- /dev/null +++ b/3.0/client/Python/pylibgal3/.gitignore @@ -0,0 +1,4 @@ +*.pyc +test.py +MANIFEST +dist diff --git a/3.0/client/Python/pylibgal3/KNOWN_ISSUES b/3.0/client/Python/pylibgal3/KNOWN_ISSUES new file mode 100644 index 00000000..7cad5280 --- /dev/null +++ b/3.0/client/Python/pylibgal3/KNOWN_ISSUES @@ -0,0 +1,13 @@ +========= +pylibgal3 +========= +* Need to implement member sorting +* Need to implement thumbnail access and manipulation +* Need to implement image resizing +* The getRandomImage() does not currently work + +========= +Gallery 3 +========= +* It appears that the 3.0 release of Gallery has a broken implementation + of the random image retrieval diff --git a/3.0/client/Python/pylibgal3/LICENSE b/3.0/client/Python/pylibgal3/LICENSE new file mode 100644 index 00000000..94a9ed02 --- /dev/null +++ b/3.0/client/Python/pylibgal3/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/3.0/client/Python/pylibgal3/MANIFEST.in b/3.0/client/Python/pylibgal3/MANIFEST.in new file mode 100644 index 00000000..3ca15d46 --- /dev/null +++ b/3.0/client/Python/pylibgal3/MANIFEST.in @@ -0,0 +1,2 @@ +include KNOWN_ISSUES +include LICENSE diff --git a/3.0/client/Python/pylibgal3/README b/3.0/client/Python/pylibgal3/README new file mode 100644 index 00000000..57114ce3 --- /dev/null +++ b/3.0/client/Python/pylibgal3/README @@ -0,0 +1,21 @@ +======= +Install +======= + +To install this libary, just do the usual Python setup: + +# tar -xvzf libgal3-*.tar.gz +# cd libgal3-* +# python setup.py install + +That's it for install. You should be able to import the libg3 library after +that: + +(In your python script) +import libg3 + +============= +Documentation +============= + +See http://stuffivelearned.org/doku.php?id=programming:python:libgal3 for documentation info. diff --git a/3.0/client/Python/pylibgal3/libg3/Errors.py b/3.0/client/Python/pylibgal3/libg3/Errors.py new file mode 100644 index 00000000..399bc259 --- /dev/null +++ b/3.0/client/Python/pylibgal3/libg3/Errors.py @@ -0,0 +1,51 @@ +# +# Author: Jay Deiman +# Email: admin@splitstreams.com +# +# This file is part of pylibgal3. +# +# pylibgal3 is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# pylibgal3 is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with pylibgal3. If not, see . +# + +__all__ = ['G3Error' , 'G3RequestError' , 'G3InvalidRespError' , + 'G3UnknownTypeError' , 'G3AuthError' , 'G3UnknownError'] + +class G3Error(Exception): + pass + +class G3RequestError(G3Error): + def __init__(self , errDict): + self.errors = errDict + self._message = self._getMessage() + + def _getMessage(self): + ret = '' + for e in self.errors.items(): + ret += '%s: %r\n' % e + return ret + + def __str__(self): + return self._message + +class G3InvalidRespError(G3Error): + pass + +class G3UnknownTypeError(G3InvalidRespError): + pass + +class G3AuthError(G3Error): + pass + +class G3UnknownError(G3Error): + pass diff --git a/3.0/client/Python/pylibgal3/libg3/G3Items.py b/3.0/client/Python/pylibgal3/libg3/G3Items.py new file mode 100644 index 00000000..f6477bb8 --- /dev/null +++ b/3.0/client/Python/pylibgal3/libg3/G3Items.py @@ -0,0 +1,469 @@ +# +# Author: Jay Deiman +# Email: admin@splitstreams.com +# +# This file is part of pylibgal3. +# +# pylibgal3 is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# pylibgal3 is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with pylibgal3. If not, see . +# + +__all__ = ['Album' , 'Image' , 'LocalImage' , 'RemoteImage' , 'LocalMovie' , + 'RemoteMovie' , 'getItemFromResp' , 'getItemsFromResp'] + +from datetime import datetime +import json , weakref , types , os , mimetypes , re + +class BaseRemote(object): + def __init__(self , respObj , weakGalObj , weakParent=None): + self._setAttrItems(respObj.items()) + if 'entity' in respObj: + self._setAttrItems(respObj['entity'].items()) + self._weakParent = None + if weakParent is not None: + self._weakParent = weakParent + self._weakGal = weakGalObj + self.fh = None + self._postInit() + + def __getattr__(self , name): + """ + A bit of magic to make the retrieval of member objects lazy + """ + # Process the specials + if name == 'members': + self.members = self._getMemberObjects() + return self.members + if name == 'tags': + self.tags = self._getTags() + return self.tags + if name == 'comments': + self.comments = self._getComments() + return self.comments + # Process the weak reference calls + if name == '_gal': + return self._weakGal() + if name == 'parent' and self._weakParent is not None: + return self._weakParent() + # Process the generic items + urlAttr = '_%s' % name + # Call __getattribute__ to prevent loops + attr = object.__getattribute__(self , urlAttr) + if attr is not None and attr.startswith('http'): + obj = self._getUrlObject(attr) + setattr(self , name , obj) + return obj + raise AttributeError(name) + + def _postInit(self): + """ + This can be overridden in subclasses to do any special initialization + at the end of the __init__ call + """ + pass + + def _setAttrItems(self , d): + for k , v in d: + if k == 'entity': + # Skip it + continue + if (type(v) in types.StringTypes and v.startswith('http') and + 'url' not in k) or k == 'members': + setattr(self , '_%s' % k , v) + else: + setattr(self , k , v) + + def _getMemberObjects(self): + """ + This returns the appropriate objects for each child of this object. + The default "members" attribute only contains the URLs for the + children of this object. This returns a list of the actual objects. + """ + memObjs = self._gal.getItemsForUrls(self._members , self) + return memObjs + + def _getTags(self): + """ + Returns the list of tag objects + + returns(list[Tag]) + """ + # First, I want just the actual tag itself, not the RESTy "tag_item", + # so I'm going to modify the urls to save a step + ret = [] + urls = [] + for url in self.relationships['tags']['members']: + m = re.match('^(.*?/tag)_item(/\d+),\d+$' , url) + urls.append('%s%s' % tuple(m.groups())) + if urls: + for url in urls: + resp = self._gal.getRespFromUrl(url) + ret.append(getItemFromResp(resp , self._gal , self)) + return ret + + def _getComments(self): + """ + Returns a list of the Comment items for this item + + returns(list[Comment]) : Returns a list of Comment objects + """ + ret = [] + # I can't use the shortcut I did for tags so I need to get the list + # of comments in the first call and then create the objects with + # the calls thereafter + commListUrl = self.relationships['comments']['url'] + resp = self._gal.getRespFromUrl(commListUrl) + tmpObj = json.loads(resp.read()) + for url in tmpObj['members']: + resp = self._gal.getRespFromUrl(url) + ret.append(getItemFromResp(resp , self._gal , self)) + return ret + + def _getUrlObject(self , url): + """ + This returns the album cover image + """ + resp = self._gal.getRespFromUrl(url) + return getItemFromResp(resp , self._gal , self) + + def getCrDT(self): + """ + Returns a datetime object for the time this item was created + """ + if hasattr(self , 'created'): + return datetime.fromtimestamp(int(self.created)) + return None + + def getUpdDT(self): + """ + Returns a datetime object for the time this item was last updated + """ + if hasattr(self , 'updated'): + return datetime.fromtimestamp(int(self.updated)) + return None + + def delete(self): + """ + Deletes this + + returns(tuple(status , msg)) : Returns a tuple of a boolean status + and a message if there is an error + """ + return self._gal.deleteItem(self) + + def update(self , title=None , description=None): + """ + Update either the title, the description or both + + title(str) : The new item title + description(str) : The new item description + + returns(tuple(status , msg)) : Returns a tuple of a boolean status + and a message if there is an error + """ + if title is not None: + self.title = title + if description is not None: + self.description = description + return self._gal.updateItem(self) + + def tag(self , tagName): + """ + Tag this item with the string "tagName" + + tagName(str) : The actual tag name + + returns(Tag) : The tag that was created + """ + return self._gal.tagItem(self , tagName) + +class Album(BaseRemote): + def addImage(self , image , title='' , description='' , name=''): + """ + Add a LocalImage object to the album + + image(LocalImage) : The image to upload + + returns(RemoteImage) : The RemoteImage object that was created + """ + if not isinstance(image , LocalImage): + raise TypeError('%r is not of type LocalImage' % image) + return self._gal.addImage(self , image , title , description , name) + + def addMovie(self , movie , name='' , title='' , description=''): + """ + Adds a LocalMovie object to the album + + movie(LocalMovie) : The movie to upload + + returns(RemoteMovie) : The RemoteMovie object that was created + """ + return self._gal.addMovie(self , movie , title , description , name) + + def addAlbum(self , albumName , title , description=''): + """ + Add a subalbum to this album + + albumName(str) : The name of the new album + title(str) : The album title + description(str): The album description + + returns(Album) : The Album object that was created + """ + return self._gal.addAlbum(self , albumName , title , description) + + def setCover(self , image): + """ + Sets the album cover to the RemoteImage + + image(RemoteImage) : The image to set as the album cover + + returns(tuple(status , msg)) : Returns a tuple of a boolean status + and a message if there is an error + """ + return self._gal.setAlbumCover(self , image) + + def getAlbums(self): + """ + Return a list of the sub-albums in this album + + returns(list[Album]) : A list of Album objects + """ + return self._getByType('album') + Albums = property(getAlbums) + + def getImages(self): + """ + Return a list of the images in this album + + returns(list[RemoteImage]) : A list of RemoteImages + """ + return self._getByType('photo') + Images = property(getImages) + + def getMovies(self): + """ + Return a list of the movies in this album + + returns(list[RemoteMovie]) : A list of RemoteMovie objects + """ + return self._getByType('movie') + Movies = property(getMovies) + + def getRandomImage(self , direct=True): + """ + Returns a random RemoteImage object for the album. If "direct" is + False, a random image can be pulled from nested albums. + + direct(bool) : If set to False, the image may be pulled from + a sub-album + + returns(RemoteImage) : Returns a RemoteImage instance + """ + return self._gal.getRandomImage(self , direct) + + def _getByType(self , t): + ret = [] + for m in self.members: + if m.type == t: + ret.append(m) + return ret + +class Image(object): + contentType = '' + +class LocalImage(Image): + def __init__(self , path , replaceSpaces=True): + if not os.path.isfile(path): + raise IOError('%s is not a file' % path) + self.path = path + self.replaceSpaces = replaceSpaces + self.Filename = os.path.basename(self.path) + self.fh = None + self.type = 'photo' + + def setContentType(self , ctype=None): + if ctype is not None: + self.contentType = ctype + self.contentType = mimetypes.guess_type(self.getFileContents())[0] or \ + 'application/octet-stream' + def getContentType(self): + if not self.contentType: + self.setContentType() + return self.contentType + ContentType = property(getContentType , setContentType) + + def setFilename(self , name): + self.filename = name + if self.replaceSpaces: + self.filename = self.filename.replace(' ' , '_') + def getFilename(self): + return self.filename + Filename = property(getFilename , setFilename) + + def getFileContents(self): + """ + Gets the entire contents of the file + + returns(str) : File contents + """ + if self.fh is None: + self.fh = open(self.path , 'rb') + self.fh.seek(0) + return self.fh.read() + + def getUploadContent(self): + """ + This will return a string containing the MIME headers and the actual + binary content to be uploaded + """ + ret = 'Content-Disposition: form-data; name="file"; ' + ret += 'filename="%s"\r\n' % self.filename + ret += 'Content-Type: %s\r\n' % self.ContentType + ret += 'Content-Transfer-Encoding: binary\r\n' + ret += '\r\n' + ret += self.getFileContents() + '\r\n' + return ret + + def close(self): + try: + self.fh.close() + except: + pass + +class RemoteImage(BaseRemote , Image): + def addComment(self , comment): + """ + Comment on this item with the string "comment" + + comment(str) : The comment + + returns(Comment) : The comment that was created + """ + return self._gal.addComment(self , comment) + + def read(self , length=None): + if not self.fh: + resp = self._gal.getRespFromUrl(self.file_url) + self.fh = resp + if length is None: + return self.fh.read() + return self.fh.read(int(length)) + + def close(self): + try: + self.fh.close() + except: + pass + +class LocalMovie(LocalImage): + def __init__(self , path , replaceSpaces=True): + LocalImage.__init__(self , path , replaceSpaces) + self.type = 'movie' + +class RemoteMovie(RemoteImage): + pass + +class Tag(BaseRemote): + """ + A simple class to represent a tag + """ + def __str__(self): + return self.name + + def _postInit(self): + if hasattr(self , 'count'): + self.count = int(self.count) + self.type = 'tag' + + def tag(self , tagName): + raise G3Error('You cannot tag a tag') + +class Comment(BaseRemote): + """ + A class to represent a comment + """ + def __str__(self): + return self.text + + def _postInit(self): + # Change the "item" attribute to "parent" since that's what it is + # I'm doing this to address overall consistency + self._parent = None + if hasattr(self , '_item'): + self._parent = getattr(self , '_item') + + def tag(self , tagName): + raise G3Error('You cannot tag a comment') + +def getItemFromResp(response , galObj , parent=None): + """ + Returns the appropriate item given the "addinfourl" response object from + the urllib2 request + + response(addinfourl|dict) : The response object from the urllib2 request + or a dict that has already been converted + (usually when called from getItemsFromResp) + galObj(Gallery3) : The gallery object this is associated with + parent(Album) : The parent object for this item + + returns(BaseRemote) : Returns an implemenation of BaseRemote + """ + galObj = weakref.ref(galObj) + if parent is not None: + parent = weakref.ref(parent) + if isinstance(response , dict): + respObj = response + else: + respObj = json.loads(response.read()) + if 'count' in respObj['entity']: + # This is a tag. It doesn't have the same items as regular objects + return Tag(respObj , galObj , parent) + if 'text' in respObj['entity']: + # This is a comment. It also does not have the same items as + # regular objects + return Comment(respObj , galObj , parent) + try: + t = respObj['entity']['type'] + except: + raise G3InvalidRespError('Response contains no "entity type": %r' % + response) + if t == 'album': + return Album(respObj , galObj , parent) + elif t == 'photo': + return RemoteImage(respObj , galObj , parent) + elif t == 'movie': + return RemoteMovie(respObj , galObj , parent) + else: + raise G3UnknownTypeError('Unknown entity type: %s' % t) + +def getItemsFromResp(response , galObj , parent=None): + """ + This takes the raw response with a list of items and returns a list of + the corresponding objects + + response(addinfourl|dict) : The response object from the urllib2 request + or a dict that has already been converted + (usually when called from getItemsFromResp) + galObj(Gallery3) : The gallery object this is associated with + parent(Album) : The parent object for this item + + returns(list[BaseRemote]) : Returns a list of BaseRemote objects + """ + ret = [] + lResp = json.loads(response.read()) + if not isinstance(lResp , list): + lResp = list(lResp) + for resp in lResp: + ret.append(getItemFromResp(resp , galObj , parent)) + return ret diff --git a/3.0/client/Python/pylibgal3/libg3/Gallery3.py b/3.0/client/Python/pylibgal3/libg3/Gallery3.py new file mode 100644 index 00000000..924d7d86 --- /dev/null +++ b/3.0/client/Python/pylibgal3/libg3/Gallery3.py @@ -0,0 +1,454 @@ +# +# Author: Jay Deiman +# Email: admin@splitstreams.com +# +# This file is part of pylibgal3. +# +# pylibgal3 is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# pylibgal3 is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with pylibgal3. If not, see . +# + +__all__ = ['Gallery3' , 'login'] + +from Requests import * +from Errors import G3RequestError , G3UnknownError +from G3Items import getItemFromResp , getItemsFromResp , BaseRemote , Album , \ + RemoteImage , Tag +from urllib import quote , urlencode +from uuid import uuid4 +import urllib2 , os , json + +class Gallery3(object): + """ + This is the main utility class that should be instantiated and used for all + calls + """ + def __init__(self , host , apiKey , g3Base='/gallery3' , port=80 , + ssl=False): + """ + Initializes and sets up the gallery 3 object + + host(str) : The hostname of the gallery site + apiKey(str) : The api key to use for the connections + g3Base(str) : The remote url path to your gallery 3 install + (default: /gallery3) + port(int) : The port number to connect to (default: 80) + ssl(bool) : If true, use SSL for the connection (default: 80) + """ + self.host = host + self.apiKey = apiKey + self.port = int(port) + self.ssl = ssl + self.g3Base = g3Base.strip('/') + self.protocol = ('http' , 'https')[ssl] + self.root = None + self._rootUri = 'index.php/rest/item/1' + self._opener = None + self._buildOpener() + + def getRoot(self): + """ + Returns the root item (album) + """ + if self.root is None: + resp = self.getRespFromUri(self._rootUri) + self.root = getItemFromResp(resp , self) + return self.root + + def getRandomImage(self , album , direct=True): + """ + Returns a random RemoteImage object for the album. If "direct" is + False, a random image can be pulled from nested albums. + + album(Album) : The album object to pull the random image from + direct(bool) : If set to False, the image may be pulled from + a sub-album + + returns(RemoteImage) : Returns a RemoteImage instance + """ + scope = ('all' , 'direct')[direct] + data = { + 'type': 'photo' , + 'random': 'true' , + 'scope': scope , + } + url = '%s?%s' % (album.url , urlencode(data)) + resp = self.getRespFromUrl(url) + return getItemFromResp(resp , self) + + def getItemsForUrls(self , urls , parent=None): + """ + This retrieves an item for each url specified in the urls list + + urls(list[str]) : The list of urls to retrieve + + returns(list[BaseRemote]) : Returns a list of the corresponding + remote objects + """ + data = { + 'urls': json.dumps(urls) , + } + resp = self.getRespFromUri('index.php/rest/items' , data) + return getItemsFromResp(resp , self , parent) + + def getRespFromUrl(self , url): + """ + This returns the response object given a full url rather than just a + uri defining the location on the server + + url(str) : The url to the resource + """ + req = GetRequest(url , self.apiKey) + resp = self._openReq(req) + return resp + + def getRespFromUri(self , uri , kwargs={}): + """ + Performs the request for the given uri and returns the "addinfourl" + response + + uri(str) : The uri string defining the resource on the defined host + """ + url = self._buildUrl(uri , kwargs) + return self.getRespFromUrl(url) + + def addAlbum(self , parent , albumName , title , description=''): + """ + Adds an album to the given parent album + + parent(Album) : The parent Album object + albumName(str) : The name of the album + title(str) : The album title + description(str) : The album description + + returns(Album) : The Album object that was created + """ + if not parent.can_edit: + raise G3AuthError('You do not have permission to edit: %s' % + parent.title) + data = { + 'type': 'album' , + 'name': albumName , + 'title': title , + 'description': description , + } + req = PostRequest(parent.url , self.apiKey , data) + resp = self._openReq(req) + newObjUrl = self._getUrlFromResp(resp) + item = getItemFromResp(self.getRespFromUrl(newObjUrl) , self , parent) + parent._members.append(newObjUrl) + parent.members.append(item) + return item + + def addImage(self , parent , image , title='' , description='' , name=''): + """ + Add a LocalImage to the parent album. + + parent(Album) : The parent album to add the image to + image(LocalImage) : The local image to upload and add to the + parent + title(str) : The image title + description(str) : The image description + name(str) : The image file name + + returns(RemoteImage) : The RemoteImage instance for the item + uploaded + """ + if not parent.can_edit: + raise G3AuthError('You do not have permission to edit: %s' % + parent.title) + if name: + image.Filename = name + entity = { + 'name': image.filename , + 'type': image.type , + 'title': title , + 'description': description , + } + boundary = str(uuid4()) + headers = {'Content-Type': 'multipart/form-data; boundary=%s' % + boundary} + # this is more complicated than adding an album. We have to + # construct the upload MIME headers, including build the string + # data section + data = '--%s\r\n' % boundary + data += 'Content-Disposition: form-data; name="entity"\r\n' + data += 'Content-Type: text/plain; ' \ + 'charset=UTF-8\r\n' + data += 'Content-Transfer-Encoding: 8bit\r\n' + data += '\r\n' + data += '%s\r\n' % json.dumps(entity , separators=(',' , ':')) + data += '--%s\r\n' % boundary + data += image.getUploadContent() + data += '--%s--\r\n' % boundary + req = PostRequest(parent.url , self.apiKey , data , headers) + resp = self._openReq(req) + newObjUrl = self._getUrlFromResp(resp) + item = getItemFromResp(self.getRespFromUrl(newObjUrl) , self , parent) + parent._members.append(newObjUrl) + parent.members.append(item) + return item + + def addMovie(self , parent , movie , title='' , description='' , name=''): + """ + Add a LocalMovie to the parent album. + + parent(Album) : The parent album to add the movie to + image(LocalMovie) : The local movie to upload and add to the + parent + title(str) : The movie title + description(str) : The movie description + name(str) : The movie file name + + returns(RemoteMovie) : The RemoteMovie instance for the movie + uploaded + """ + return self.addImage(parent , movie , title , description , name) + + def setAlbumCover(self , album , image): + """ + Updates a remote item's title and description + + album(Album) : The album to set the cover on + image(RemoteImage) : The image to use as the cover + + returns(tuple(status , msg)) : Returns a tuple of a boolean status + and a message if there is an error + """ + if not album.can_edit: + raise G3AuthError('You do not have permission to edit: %s' % + album.title) + try: + self._isItemValid(album , Album) + self._isItemValid(image , RemoteImage) + except Exception , e: + return (False , str(e)) + data = { + 'album_cover': image.url , + } + req = PutRequest(album.url , self.apiKey , data) + try: + resp = self._openReq(req) + except G3RequestError , e: + return (False , str(e)) + album.album_cover = image + album._album_cover = image.url + return (True , '') + + def updateItem(self , item): + """ + Updates a remote item's title and description + + item(BaseRemote) : An item descended from BaseRemote + + returns(tuple(status , msg)) : Returns a tuple of a boolean status + and a message if there is an error + """ + if not item.can_edit: + raise G3AuthError('You do not have permission to edit: %s' % + item.title) + try: + self._isItemValid(item , BaseRemote) + except Exception , e: + return (False , str(e)) + data = { + 'title': item.title , + 'description': item.description , + } + req = PutRequest(item.url , self.apiKey , data) + try: + resp = self._openReq(req) + except G3RequestError , e: + return (False , str(e)) + return (True , '') + + def updateAlbum(self , album): + """ + Update the title and description for an album. + + image(Album) : Updates the title and/or description + for the Album + + returns(tuple(status , msg)) : Returns a tuple of a boolean status + and a message if there is an error + """ + return self.updateItem(album) + + def updateImage(self , image): + """ + Update the title and description for an image. + + image(RemoteImage) : Updates the title and/or description for the + RemoteImage + + returns(tuple(status , msg)) : Returns a tuple of a boolean status + and a message if there is an error + """ + return self.updateItem(image) + + def updateMovie(self , movie): + """ + Update the title and description for a movie. + + image(RemoteMovie) : Updates the title and/or description for the + RemoteMovie + + returns(tuple(status , msg)) : Returns a tuple of a boolean status + and a message if there is an error + """ + return self.updateItem(movie) + + def deleteItem(self , item): + """ + Deletes the given item. Item must be descended from BaseRemote. + + item(BaseRemote) : The item to delete + + returns(tuple(status , msg)) : Returns a tuple of a boolean status + and a message if there is an error + """ + if not item.can_edit: + raise G3AuthError('You do not have permission to edit: %s' % + item.title) + try: + self._isItemValid(item , BaseRemote) + except Exception , e: + return (False , e.message) + req = DeleteRequest(item.url , self.apiKey) + try: + resp = self._openReq(req) + except G3RequestError , e: + return (False , e.message) + return (True , '') + + def tagItem(self , item , tagName): + """ + Tag this item with the string "tagName" + + tagName(str) : The actual tag name + + returns(Tag) : The tag that was created + """ + # First we have to create the tag itself, if necessary + data = { + 'name': str(tagName) , + } + url = self._buildUrl('index.php/rest/tags') + req = PostRequest(url , self.apiKey , data) + resp = self._openReq(req) + r = json.loads(resp.read()) + tagUrl = r['url'] + # And now that we have our (possibly) newly created tag, we can + # use that to tag our item + data = { + 'tag': tagUrl , + 'item': item.url , + } + url = self._buildUrl('index.php/rest/item_tags/%s' % item.id) + req = PostRequest(url , self.apiKey , data) + resp = self._openReq(req) + respObj = json.loads(resp.read()) + item.relationships['tags']['members'].append(respObj['url']) + tag = Tag(respObj , self , item) + if hasattr(item , 'tags'): + item.tags.append(tag) + return tag + + def addComment(self , image , comment): + """ + Comment on this item with the string "comment" + + comment(str) : The comment + + returns(Comment) : The comment that was created + """ + data = { + 'item': image.url , + 'text': comment , + } + url = self._buildUrl('index.php/rest/comments') + req = PostRequest(url , self.apiKey , data) + resp = self._openReq(req) + commUrl = json.loads(resp.read())['url'] + resp = self.getRespFromUrl(commUrl) + comm = getItemFromResp(resp , self , image) + if hasattr(image , 'comments'): + image.comments.append(comm) + return comm + + def _buildOpener(self): + cp = urllib2.HTTPCookieProcessor() + self._opener = urllib2.build_opener(cp) + if self.ssl: + self._opener.add_handler(urllib2.HTTPSHandler()) + + def _buildUrl(self , resource , kwargs={}): + url = '%s://%s:%d/%s/%s' % (self.protocol , self.host , self.port , + quote(self.g3Base) , quote(resource)) + if kwargs: + url += '?%s' % urlencode(kwargs) + return url + + def _getUrlFromResp(self , resp): + d = json.loads(resp.read()) + return d['url'] + + def _openReq(self , req): + try: + resp = self._opener.open(req) + except urllib2.HTTPError , e: + err = json.loads(e.read()) + if isinstance(err , dict) and 'errors' in err: + raise G3RequestError(err['errors']) + else: + raise G3UnknownError('Unknown request error: %s' % e) + return resp + + def _isItemValid(self , item , cls): + if not isinstance(item , cls): + raise TypeError('Items to be modified must be descended from ' + '%s: %s' % (cls , type(item))) + if not 'url' in item.__dict__: + raise G3UnknownError('The object, %s, has no "url"' % item) + +def login(host , username , passwd , g3Base='/gallery3' , port=80 , + ssl=False): + """ + This will log you in and return a Gallery3 object on success, None + otherwise + + host(str) : The hostname of the gallery site + username(str) : The username to login with + passwd(str) : The password to login with + g3Base(str) : The remote url path to your gallery 3 install + (default: /gallery3) + port(int) : The port number to connect to (default: 80) + ssl(bool) : If true, use SSL for the connection (default: 80) + """ + data = { + 'user': username , + 'password': passwd , + } + protocol = ('http' , 'https')[ssl] + url = '%s://%s:%d/%s/index.php/rest' % (protocol , host , port , + quote(g3Base)) + req = PostRequest(url , None , urlencode(data)) + opener = urllib2.build_opener() + if ssl: + opener.add_handler(urllib2.HTTPSHandler()) + try: + resp = opener.open(req) + except urllib2.HTTPError , e: + return None + apiKey = resp.read().strip('\'"') + return Gallery3(host , apiKey , g3Base , port , ssl) diff --git a/3.0/client/Python/pylibgal3/libg3/Requests.py b/3.0/client/Python/pylibgal3/libg3/Requests.py new file mode 100644 index 00000000..7b0fedb6 --- /dev/null +++ b/3.0/client/Python/pylibgal3/libg3/Requests.py @@ -0,0 +1,72 @@ +# +# Author: Jay Deiman +# Email: admin@splitstreams.com +# +# This file is part of pylibgal3. +# +# pylibgal3 is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# pylibgal3 is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with pylibgal3. If not, see . +# + +__all__ = ['BaseRequest' , 'GetRequest' , 'PostRequest' , 'PutRequest' , + 'DeleteRequest'] + +from urllib2 import Request +from urllib import quote +import os , json , types + +class BaseRequest(Request): + def __init__(self , url , apiKey , data=None , headers={} , + origin_req_host=None , unverifiable=False): + if apiKey is not None: + headers['X-Gallery-Request-Key'] = apiKey + if data is not None: + if isinstance(data , dict): + data = 'entity=%s' % quote(json.dumps(data , + separators=(',' , ':'))) + elif type(data) not in types.StringTypes: + raise TypeError('Invalid type for data. It should be ' + 'a "dict" or "str", not %s' % type(data)) + headers['Content-Length'] = str(len(data)) + Request.__init__(self , url , data , headers , origin_req_host , + unverifiable) + +class GetRequest(BaseRequest): + def __init__(self , url , apiKey , data=None , headers={} , + origin_req_host=None , unverifiable=False): + headers['X-Gallery-Request-Method'] = 'get' + BaseRequest.__init__(self , url , apiKey , data , headers , + origin_req_host , unverifiable) + +class PostRequest(BaseRequest): + def __init__(self , url , apiKey , data , headers={} , + origin_req_host=None , unverifiable=False): + headers['X-Gallery-Request-Method'] = 'post' + if 'Content-Type' not in headers: + headers['Content-Type'] = 'application/x-www-form-urlencoded' + BaseRequest.__init__(self , url , apiKey , data , headers , + origin_req_host , unverifiable) + +class PutRequest(BaseRequest): + def __init__(self , url , apiKey , data=None , headers={} , + origin_req_host=None , unverifiable=False): + headers['X-Gallery-Request-Method'] = 'put' + BaseRequest.__init__(self , url , apiKey , data , headers , + origin_req_host , unverifiable) + +class DeleteRequest(BaseRequest): + def __init__(self , url , apiKey , data=None , headers={} , + origin_req_host=None , unverifiable=False): + headers['X-Gallery-Request-Method'] = 'delete' + BaseRequest.__init__(self , url , apiKey , data , headers , + origin_req_host , unverifiable) diff --git a/3.0/client/Python/pylibgal3/libg3/__init__.py b/3.0/client/Python/pylibgal3/libg3/__init__.py new file mode 100644 index 00000000..745ba345 --- /dev/null +++ b/3.0/client/Python/pylibgal3/libg3/__init__.py @@ -0,0 +1,24 @@ +# +# Author: Jay Deiman +# Email: admin@splitstreams.com +# +# This file is part of pylibgal3. +# +# pylibgal3 is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# pylibgal3 is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with pylibgal3. If not, see . +# + +from G3Items import * +from Gallery3 import * + +__version__ = '0.1.3' diff --git a/3.0/client/Python/pylibgal3/setup.py b/3.0/client/Python/pylibgal3/setup.py new file mode 100644 index 00000000..ba9d1d82 --- /dev/null +++ b/3.0/client/Python/pylibgal3/setup.py @@ -0,0 +1,36 @@ +#!/usr/bin/env python + +# +# Author: Jay Deiman +# Email: admin@splitstreams.com +# +# This file is part of pylibgal3. +# +# pylibgal3 is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# pylibgal3 is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with pylibgal3. If not, see . +# + + +from distutils.core import setup +from libg3 import __version__ as version +import sys + +setup(name='pylibgal3' , + version=version , + author='Jay Deiman' , + author_email='admin@splitstreams.com' , + url='http://stuffivelearned.org' , + description='A library for accessing/manipulating a Gallery 3 install' , + packages=['libg3'] , + package_dir={'libg3': 'libg3'} , +) From a192cb879aceacc654cae248c12813c5ed053f98 Mon Sep 17 00:00:00 2001 From: Jay Deiman Date: Sat, 25 Dec 2010 18:18:47 -0600 Subject: [PATCH 07/17] Fixed large member access (over 100) --- 3.0/client/Python/pylibgal3/libg3/Gallery3.py | 20 ++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/3.0/client/Python/pylibgal3/libg3/Gallery3.py b/3.0/client/Python/pylibgal3/libg3/Gallery3.py index 924d7d86..6345c1a8 100644 --- a/3.0/client/Python/pylibgal3/libg3/Gallery3.py +++ b/3.0/client/Python/pylibgal3/libg3/Gallery3.py @@ -95,11 +95,20 @@ class Gallery3(object): returns(list[BaseRemote]) : Returns a list of the corresponding remote objects """ - data = { - 'urls': json.dumps(urls) , - } - resp = self.getRespFromUri('index.php/rest/items' , data) - return getItemsFromResp(resp , self , parent) + numUrls = len(urls) + start = 0 + increment = 25 + ret = [] + while start < numUrls: + data = { + 'urls': json.dumps(urls[start:start+increment]) , + 'num': str(increment) , + 'start': str(start) , + } + resp = self.getRespFromUri('index.php/rest/items' , data) + ret.extend(getItemsFromResp(resp , self , parent)) + start += increment + return ret def getRespFromUrl(self , url): """ @@ -120,6 +129,7 @@ class Gallery3(object): uri(str) : The uri string defining the resource on the defined host """ url = self._buildUrl(uri , kwargs) + print url return self.getRespFromUrl(url) def addAlbum(self , parent , albumName , title , description=''): From 97ccfc9865791c27c750c9b99ac978511d581773 Mon Sep 17 00:00:00 2001 From: Jay Deiman Date: Sat, 25 Dec 2010 18:20:12 -0600 Subject: [PATCH 08/17] Added resize and thumbnail access --- 3.0/client/Python/pylibgal3/libg3/G3Items.py | 33 ++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/3.0/client/Python/pylibgal3/libg3/G3Items.py b/3.0/client/Python/pylibgal3/libg3/G3Items.py index f6477bb8..0fdae593 100644 --- a/3.0/client/Python/pylibgal3/libg3/G3Items.py +++ b/3.0/client/Python/pylibgal3/libg3/G3Items.py @@ -36,6 +36,13 @@ class BaseRemote(object): self.fh = None self._postInit() + def __str__(self): + try: + return self.title + except: + pass + return self.name + def __getattr__(self , name): """ A bit of magic to make the retrieval of member objects lazy @@ -366,6 +373,32 @@ class RemoteImage(BaseRemote , Image): except: pass + def getResizeHandle(self): + """ + Returns a file-like object (specifically a urllib2.addinfourl) handle + to the "resize" version of the image + + returns(urllib2.addinfourl) : A file-like object handle for retrieving + the resized image + """ + if hasattr(self , 'resize_url'): + resp = self._gal.getRespFromUrl(self.resize_url) + return resp + return None + + def getThumbHandle(self): + """ + Returns a file-like object (specifically a urllib2.addinfourl) handle + to the "thumbnail" version of the image + + returns(urllib2.addinfourl) : A file-like object handle for retrieving + the thumbnail image + """ + if hasattr(self , 'thumb_url'): + resp = self._gal.getRespFromUrl(self.thumb_url) + return resp + return None + class LocalMovie(LocalImage): def __init__(self , path , replaceSpaces=True): LocalImage.__init__(self , path , replaceSpaces) From 093c4e7998be549669aaaadff012a9ef6dd33226 Mon Sep 17 00:00:00 2001 From: Jay Deiman Date: Sat, 25 Dec 2010 18:20:58 -0600 Subject: [PATCH 09/17] version bump and updated issues --- 3.0/client/Python/pylibgal3/KNOWN_ISSUES | 1 - 3.0/client/Python/pylibgal3/libg3/__init__.py | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/3.0/client/Python/pylibgal3/KNOWN_ISSUES b/3.0/client/Python/pylibgal3/KNOWN_ISSUES index 7cad5280..ebc02f79 100644 --- a/3.0/client/Python/pylibgal3/KNOWN_ISSUES +++ b/3.0/client/Python/pylibgal3/KNOWN_ISSUES @@ -2,7 +2,6 @@ pylibgal3 ========= * Need to implement member sorting -* Need to implement thumbnail access and manipulation * Need to implement image resizing * The getRandomImage() does not currently work diff --git a/3.0/client/Python/pylibgal3/libg3/__init__.py b/3.0/client/Python/pylibgal3/libg3/__init__.py index 745ba345..eec91668 100644 --- a/3.0/client/Python/pylibgal3/libg3/__init__.py +++ b/3.0/client/Python/pylibgal3/libg3/__init__.py @@ -21,4 +21,4 @@ from G3Items import * from Gallery3 import * -__version__ = '0.1.3' +__version__ = '0.1.4' From 0e65453cf133ed59f1220ae661a09850f8d32131 Mon Sep 17 00:00:00 2001 From: Jay Deiman Date: Sun, 26 Dec 2010 08:18:47 +0800 Subject: [PATCH 10/17] Fixed large member access (over 100) --- 3.0/client/Python/pylibgal3/libg3/Gallery3.py | 20 ++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/3.0/client/Python/pylibgal3/libg3/Gallery3.py b/3.0/client/Python/pylibgal3/libg3/Gallery3.py index 924d7d86..6345c1a8 100644 --- a/3.0/client/Python/pylibgal3/libg3/Gallery3.py +++ b/3.0/client/Python/pylibgal3/libg3/Gallery3.py @@ -95,11 +95,20 @@ class Gallery3(object): returns(list[BaseRemote]) : Returns a list of the corresponding remote objects """ - data = { - 'urls': json.dumps(urls) , - } - resp = self.getRespFromUri('index.php/rest/items' , data) - return getItemsFromResp(resp , self , parent) + numUrls = len(urls) + start = 0 + increment = 25 + ret = [] + while start < numUrls: + data = { + 'urls': json.dumps(urls[start:start+increment]) , + 'num': str(increment) , + 'start': str(start) , + } + resp = self.getRespFromUri('index.php/rest/items' , data) + ret.extend(getItemsFromResp(resp , self , parent)) + start += increment + return ret def getRespFromUrl(self , url): """ @@ -120,6 +129,7 @@ class Gallery3(object): uri(str) : The uri string defining the resource on the defined host """ url = self._buildUrl(uri , kwargs) + print url return self.getRespFromUrl(url) def addAlbum(self , parent , albumName , title , description=''): From 530215e2b5686df9c3c92cebe4a7f13dd7ec64d7 Mon Sep 17 00:00:00 2001 From: Jay Deiman Date: Sun, 26 Dec 2010 08:20:12 +0800 Subject: [PATCH 11/17] Added resize and thumbnail access --- 3.0/client/Python/pylibgal3/libg3/G3Items.py | 33 ++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/3.0/client/Python/pylibgal3/libg3/G3Items.py b/3.0/client/Python/pylibgal3/libg3/G3Items.py index f6477bb8..0fdae593 100644 --- a/3.0/client/Python/pylibgal3/libg3/G3Items.py +++ b/3.0/client/Python/pylibgal3/libg3/G3Items.py @@ -36,6 +36,13 @@ class BaseRemote(object): self.fh = None self._postInit() + def __str__(self): + try: + return self.title + except: + pass + return self.name + def __getattr__(self , name): """ A bit of magic to make the retrieval of member objects lazy @@ -366,6 +373,32 @@ class RemoteImage(BaseRemote , Image): except: pass + def getResizeHandle(self): + """ + Returns a file-like object (specifically a urllib2.addinfourl) handle + to the "resize" version of the image + + returns(urllib2.addinfourl) : A file-like object handle for retrieving + the resized image + """ + if hasattr(self , 'resize_url'): + resp = self._gal.getRespFromUrl(self.resize_url) + return resp + return None + + def getThumbHandle(self): + """ + Returns a file-like object (specifically a urllib2.addinfourl) handle + to the "thumbnail" version of the image + + returns(urllib2.addinfourl) : A file-like object handle for retrieving + the thumbnail image + """ + if hasattr(self , 'thumb_url'): + resp = self._gal.getRespFromUrl(self.thumb_url) + return resp + return None + class LocalMovie(LocalImage): def __init__(self , path , replaceSpaces=True): LocalImage.__init__(self , path , replaceSpaces) From d6b753b8f604a0f895fa4f10996a1569d6f33ce0 Mon Sep 17 00:00:00 2001 From: Jay Deiman Date: Sun, 26 Dec 2010 08:20:58 +0800 Subject: [PATCH 12/17] version bump and updated issues --- 3.0/client/Python/pylibgal3/KNOWN_ISSUES | 1 - 3.0/client/Python/pylibgal3/libg3/__init__.py | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/3.0/client/Python/pylibgal3/KNOWN_ISSUES b/3.0/client/Python/pylibgal3/KNOWN_ISSUES index 7cad5280..ebc02f79 100644 --- a/3.0/client/Python/pylibgal3/KNOWN_ISSUES +++ b/3.0/client/Python/pylibgal3/KNOWN_ISSUES @@ -2,7 +2,6 @@ pylibgal3 ========= * Need to implement member sorting -* Need to implement thumbnail access and manipulation * Need to implement image resizing * The getRandomImage() does not currently work diff --git a/3.0/client/Python/pylibgal3/libg3/__init__.py b/3.0/client/Python/pylibgal3/libg3/__init__.py index 745ba345..eec91668 100644 --- a/3.0/client/Python/pylibgal3/libg3/__init__.py +++ b/3.0/client/Python/pylibgal3/libg3/__init__.py @@ -21,4 +21,4 @@ from G3Items import * from Gallery3 import * -__version__ = '0.1.3' +__version__ = '0.1.4' From 9fc5a87ec25d7133a70bd974af929e42a52ae8c0 Mon Sep 17 00:00:00 2001 From: Chad Kieffer Date: Thu, 23 Dec 2010 06:10:27 +0800 Subject: [PATCH 13/17] Initial commit of bitly module. Installer and admin settings implemented. URL shortening method works but is not yet implemented for items. --- 3.1/modules/bitly/controllers/admin_bitly.php | 91 +++++++ 3.1/modules/bitly/helpers/bitly.php | 257 ++++++++++++++++++ 3.1/modules/bitly/helpers/bitly_event.php | 50 ++++ 3.1/modules/bitly/helpers/bitly_installer.php | 38 +++ 3.1/modules/bitly/helpers/bitly_theme.php | 24 ++ 3.1/modules/bitly/js/bitly.js | 8 + 3.1/modules/bitly/models/bitly.php | 29 ++ 3.1/modules/bitly/module.info | 3 + 3.1/modules/bitly/views/admin_bitly.html.php | 18 ++ 9 files changed, 518 insertions(+) create mode 100644 3.1/modules/bitly/controllers/admin_bitly.php create mode 100644 3.1/modules/bitly/helpers/bitly.php create mode 100644 3.1/modules/bitly/helpers/bitly_event.php create mode 100644 3.1/modules/bitly/helpers/bitly_installer.php create mode 100644 3.1/modules/bitly/helpers/bitly_theme.php create mode 100644 3.1/modules/bitly/js/bitly.js create mode 100644 3.1/modules/bitly/models/bitly.php create mode 100644 3.1/modules/bitly/module.info create mode 100644 3.1/modules/bitly/views/admin_bitly.html.php diff --git a/3.1/modules/bitly/controllers/admin_bitly.php b/3.1/modules/bitly/controllers/admin_bitly.php new file mode 100644 index 00000000..ee7e9f6f --- /dev/null +++ b/3.1/modules/bitly/controllers/admin_bitly.php @@ -0,0 +1,91 @@ +validate()) { + $current_login = module::get_var("bitly", "login"); + $current_key = module::get_var("bitly", "api_key"); + $current_domain = module::get_var("bitly", "domain"); + $new_login = $form->configure_bitly->login->value; + $new_key = $form->configure_bitly->api_key->value; + $new_domain = $form->configure_bitly->domain->value; + + module::set_var("bitly", "login", $new_login); + module::set_var("bitly", "api_key", $new_key); + module::set_var("bitly", "domain", $new_domain); + + if (!bitly::check_config()) { + url::redirect("admin/bitly"); + } else { + if ($current_login && !$new_login) { + message::success(t("Your bit.ly login has been cleared.")); + } else if ($current_login && $new_login && $current_login != $new_login) { + message::success(t("Your bit.ly login has been changed.")); + } else if (!$current_login && $new_login) { + message::success(t("Your bit.ly login has been saved.")); + } + if ($current_key && !$new_key) { + message::success(t("Your bit.ly API key has been cleared.")); + } else if ($current_key && $new_key && $current_key != $new_key) { + message::success(t("Your bit.ly API key has been changed.")); + } else if (!$current_key && $new_key) { + message::success(t("Your bit.ly API key has been saved.")); + } + if ($current_domain && $new_domain && $current_domain != $new_domain) { + message::success(t("Your preferrend bit.ly domain has been changed.")); + } else if (!$current_domain && $new_domain) { + message::success(t("Your preferred bit.ly domain has been set.")); + } + log::success("bitly", t("bit.ly login changed to %new_login", + array("new_login" => $new_login))); + log::success("bitly", t("bit.ly API key changed to %new_key", + array("new_key" => $new_key))); + + (!$new_login || !$new_key) ? $valid_config = false : $valid_config = true; + } + } + } + + $view = new Admin_View("admin.html"); + $view->page_title = t("bit.ly url shortner"); + $view->content = new View("admin_bitly.html"); + $view->content->login = $form->configure_bitly->login->value; + $view->content->api_key = $form->configure_bitly->api_key->value; + $view->content->domain = $form->configure_bitly->domain->value; + $view->content->valid_config = $valid_config; + $view->content->form = $form; + if ($valid_config) { + // @todo Store/get G3's root bit.ly url, only shorten if it hasn't been stored. + $view->content->g3_url = bitly::shorten_url(bitly::build_link()); + } + print $view; + } + +} \ No newline at end of file diff --git a/3.1/modules/bitly/helpers/bitly.php b/3.1/modules/bitly/helpers/bitly.php new file mode 100644 index 00000000..b69f7fe1 --- /dev/null +++ b/3.1/modules/bitly/helpers/bitly.php @@ -0,0 +1,257 @@ + 'expand', + 'shorten' => 'shorten', + 'validate' => 'validate', + 'clicks' => 'clicks', + 'referrers' => 'referrers', + 'countries' => 'countries', + 'clicks_by_minute' => 'clicks_by_minute', + 'clicks_by_day' => 'clicks_by_day', + 'lookup' => 'lookup', + 'info' => 'info', + ); + + static function get_configure_form() { + $form = new Forge("admin/bitly", "", "post", array("id" => "g-configure-bitly-form")); + $group = $form->group("configure_bitly")->label(t("Configure bit.ly")); + $group->input("login") + ->label(t("Login")) + ->value(module::get_var("bitly", "login")) + ->rules("required") + ->error_messages("required", t("You must enter a login")); + $group->input("api_key") + ->label(t("API Key")) + ->value(module::get_var("bitly", "api_key")) + ->rules("required") + ->error_messages("required", t("You must enter an API key")); + $group->dropdown("domain") + ->label(t("Preferred Domain")) + ->options(array("bit.ly" => "bit.ly", "j.mp" => "j.mp")) + ->selected(module::get_var("bitly", "domain")); + $group->submit("")->value(t("Save")); + return $form; + } + + /** + * Check a login and an API Key against bit.ly to make sure they're valid + * @param string $login the login + * @param string $api_key the API key + * @return boolean + */ + static function validate_config($login, $api_key) { + if (!empty($login) && !empty($api_key)) { + $parameters = array( + 'login' => $login, + 'apiKey' => $api_key, + 'x_login' => $login, + 'x_apiKey' => $api_key + ); + $request = self::_build_http_request('validate', $parameters); + $response = self::_http_post($request, "api.bit.ly"); + $json_decoded = json_decode($response->body[0]); + if (!$json_decoded->data->valid) { + if ("INVALID_LOGIN" == $json_decoded->status_txt) { + message::error(t("Your bit.ly login is incorrect")); + } else if ("INVALID_APIKEY" == $json_decoded->status_txt) { + message::error(t("Your bit.ly API Key is incorrect.")); + } + return false; + } else { + return true; + } + } + } + + /** + * Check whether the module's configured correctly + * @return boolean + */ + static function check_config() { + $login = module::get_var("bitly", "login"); + $api_key = module::get_var("bitly", "api_key"); + if (empty($login) || empty($api_key)) { + site_status::warning( + t("bit.ly is not quite ready! Please provide a login and API Key", + array("url" => html::mark_clean(url::site("admin/bitly")))), + "bitly_config"); + + } else if (!self::validate_config($login, $api_key)) { + site_status::warning( + t("bit.ly is not properly configured! URLs will not be shortened until its configuration is updated.", + array("url" => html::mark_clean(url::site("admin/bitly")))), + "bitly_config"); + } else { + site_status::clear("bitly_config"); + return true; + } + return false; + } + + /** + * + * @param $type + * @param $parameters + * @return string + */ + private static function _build_http_request($type, $parameters) { + $http_request = ''; + if (!empty($type) && count($parameters)) { + foreach($parameters as $k => $v) { + $query_string[] = "$k=" . urlencode($v); + } + $path = "/" . self::$api_version . "/$type?" . implode('&', $query_string); + $module_version = module::get_version("bitly"); + + $http_request = "GET $path HTTP/1.0\r\n"; + $http_request .= "Host: " . self::$api_host . "\r\n"; + $http_request .= "User-Agent: Gallery/3 | bitly/" . module::get_version("bitly") . "\r\n"; + $http_request .= "\r\n"; + $http_request .= $path; + } + return $http_request; + } + + /** + * Send an http POST request + * @param string $http_request + * @param string $host + * @return object + */ + private static function _http_post($http_request) { + $response = ''; + //Kohana_Log::add("debug", "Send request\n" . print_r($http_request, 1)); + if (false !== ($fs = @fsockopen(self::$api_host, 80, $errno, $errstr, 5))) { + fwrite($fs, $http_request); + while ( !feof($fs) ) { + $response .= fgets($fs, 1160); // One TCP-IP packet + } + fclose($fs); + list($headers, $body) = explode("\r\n\r\n", $response); + $headers = explode("\r\n", $headers); + $body = explode("\r\n", $body); + $response = new ArrayObject( + array("headers" => $headers, "body" => $body), ArrayObject::ARRAY_AS_PROPS); + } else { + throw new Exception("@todo CONNECTION TO URL SHORTENING SERVICE FAILED"); + } + Kohana_Log::add("debug", "Received response\n" . print_r($response, 1)); + + return $response; + } + + static function build_link($path='/') { + $protocol = strtolower(substr($_SERVER["SERVER_PROTOCOL"], 0, 5)) == 'https' ? 'https' : 'http'; + return url::site($path, $protocol); + } + + /** + * Shorten a Gallery URL + * @param string $long_url + * @param string $format + * @return string + */ + static function shorten_url($long_url, $format='json') { + $short_url = ''; + $parameters = array( + "login" => module::get_var("bitly", "login"), + 'apiKey' => module::get_var("bitly", "api_key"), + 'longUrl' => $long_url, + 'domain' => module::get_var("bitly", "domain"), + 'format' => $format, + ); + $request = self::_build_http_request('shorten', $parameters); + $response = self::_http_post($request, self::$api_host); + $json_decoded = json_decode($response->body[0]); + if ('OK' == $json_decoded->status_txt) { + // Save the original item id, the hash, and possibly the global hash, to the database + $short_url = $json_decoded->data->url; + $hash = $json_decoded->data->hash; + $global_hash = $json_decoded->data->global_hash; + $new_hash = $json_decoded->data->new_hash; + message::success("The $long_url has been shortened to $short_url"); + } else { + message::error("Unable to shorten the url"); + // @todo log the error + } + return $short_url; + } + + /** + * returns expanded url + * { + "status_code": 200, + "data": { + "expand": [ + { + "short_url": "http://tcrn.ch/a4MSUH", + "global_hash": "bWw49z", + "long_url": "http://www.techcrunch.com/2010/01/29/windows-mobile-foursquare/", + "user_hash": "a4MSUH" + }, + { + "short_url": "http://bit.ly/1YKMfY", + "global_hash": "1YKMfY", + "long_url": "http://betaworks.com/", + "user_hash": "1YKMfY" + }, + { + "long_url": "http://www.scotster.com/qf/?1152", + "global_hash": "lLWr", + "hash": "j3", + "user_hash": "j3" + }, + { + "hash": "a35.", + "error": "NOT_FOUND" + } + ] + }, + "status_txt": "OK" + } + */ + /** + * + * @param $short_url + * @param $hash + * @param $format + * @return + */ + static function expand_url($short_url, $hash=null, $format='json') { + $parameters = array( + "login" => module::get_var("bitly", "login"), + 'apiKey' => module::get_var("bitly", "api_key"), + 'shortUrl' => $short_url, + 'hash' => $hash, + ); + $request = self::_build_http_request('expand', $parameters); + $response = self::_http_post($http_request, self::$api_host); + return $response; + } + +} diff --git a/3.1/modules/bitly/helpers/bitly_event.php b/3.1/modules/bitly/helpers/bitly_event.php new file mode 100644 index 00000000..49ea72a6 --- /dev/null +++ b/3.1/modules/bitly/helpers/bitly_event.php @@ -0,0 +1,50 @@ +get("settings_menu") + ->append(Menu::factory("link") + ->id("bitly_menu") + ->label(t("Bit.ly")) + ->url(url::site("admin/bitly"))); + } + + static function site_menu($menu, $theme) { + $item = $theme->item(); + if ($item && $item->type == "photo") { + $menu->get("options_menu") + ->append(Menu::factory("link") + ->id("bitly") + ->label(t("Shorten Link with bit.ly")) + ->url(url::site("bitly/shorten_link/$item->id?csrf=$theme->csrf")) + ->css_id("g-bitly-link") + ->css_class("g-print-bitly-link ui-icon-print")); + } + } + + static function context_menu($menu, $theme, $item) { + $menu->get("options_menu") + ->append(Menu::factory("link") + ->id("bitly") + ->label(t("Shorten Link with bit.ly")) + ->url(url::site("bitly/shorten_link/$item->id?csrf=$theme->csrf")) + ->css_class("g-bitly-link ui-icon-link")); + } +} diff --git a/3.1/modules/bitly/helpers/bitly_installer.php b/3.1/modules/bitly/helpers/bitly_installer.php new file mode 100644 index 00000000..c847ec7c --- /dev/null +++ b/3.1/modules/bitly/helpers/bitly_installer.php @@ -0,0 +1,38 @@ +query("CREATE TABLE {bitly_urls} ( + `id` int(9) NOT NULL AUTO_INCREMENT, + `item_id` int(9) NOT NULL, + `hash` char(6) NOT NULL, + `user_id` int(9) NOT NULL, + PRIMARY KEY (`id`)) + DEFAULT CHARSET=utf8;"); + module::set_version("bitly", 1); + bitly::check_config(); + } + + static function deactivate() { + site_status::clear("bitly_config"); + } +} diff --git a/3.1/modules/bitly/helpers/bitly_theme.php b/3.1/modules/bitly/helpers/bitly_theme.php new file mode 100644 index 00000000..41aba38f --- /dev/null +++ b/3.1/modules/bitly/helpers/bitly_theme.php @@ -0,0 +1,24 @@ +script("bitly.js"); + } +} diff --git a/3.1/modules/bitly/js/bitly.js b/3.1/modules/bitly/js/bitly.js new file mode 100644 index 00000000..35bcd58b --- /dev/null +++ b/3.1/modules/bitly/js/bitly.js @@ -0,0 +1,8 @@ +$(document).ready(function() { + $(".g-bitly-link").click(function(e) { + e.preventDefault(); + return; + }); +}); + + diff --git a/3.1/modules/bitly/models/bitly.php b/3.1/modules/bitly/models/bitly.php new file mode 100644 index 00000000..a1b68600 --- /dev/null +++ b/3.1/modules/bitly/models/bitly.php @@ -0,0 +1,29 @@ + +
+

+

+ bit.ly account which will provide an API Key, which is also free.", + array("api_key_url" => "http://bit.ly/a/your_api_key", + "bitly_url" => "http://bit.ly")) ?> +

+
+ +
+ %g3_url", array('g3_url' => $g3_url)) ?> +
+ + + +
+
From c2bd8ef5baffb65a69c84780722c8a1573b6b480 Mon Sep 17 00:00:00 2001 From: Chad Kieffer Date: Sat, 25 Dec 2010 02:22:23 +0800 Subject: [PATCH 14/17] Changed table name and user_id is now owner_id, as it should be. --- 3.1/modules/bitly/helpers/bitly_installer.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/3.1/modules/bitly/helpers/bitly_installer.php b/3.1/modules/bitly/helpers/bitly_installer.php index c847ec7c..c55fbb66 100644 --- a/3.1/modules/bitly/helpers/bitly_installer.php +++ b/3.1/modules/bitly/helpers/bitly_installer.php @@ -21,11 +21,11 @@ class bitly_installer { static function install() { Database::instance() - ->query("CREATE TABLE {bitly_urls} ( + ->query("CREATE TABLE {bitly_links} ( `id` int(9) NOT NULL AUTO_INCREMENT, `item_id` int(9) NOT NULL, `hash` char(6) NOT NULL, - `user_id` int(9) NOT NULL, + `owner_id` int(9) NOT NULL, PRIMARY KEY (`id`)) DEFAULT CHARSET=utf8;"); module::set_version("bitly", 1); From c521fede9f0471dcfdc047b0df282826eb5afa5b Mon Sep 17 00:00:00 2001 From: Chad Kieffer Date: Sat, 25 Dec 2010 06:04:42 +0800 Subject: [PATCH 15/17] Store shortened bit.ly hashes locally. Implemented site menu's shorten link, context menu's not working yet. --- 3.1/modules/bitly/controllers/admin_bitly.php | 9 +- 3.1/modules/bitly/helpers/bitly.php | 96 +++++-------------- 3.1/modules/bitly/helpers/bitly_event.php | 20 ++-- 3.1/modules/bitly/models/bitly.php | 29 ------ 4 files changed, 42 insertions(+), 112 deletions(-) delete mode 100644 3.1/modules/bitly/models/bitly.php diff --git a/3.1/modules/bitly/controllers/admin_bitly.php b/3.1/modules/bitly/controllers/admin_bitly.php index ee7e9f6f..f4240a63 100644 --- a/3.1/modules/bitly/controllers/admin_bitly.php +++ b/3.1/modules/bitly/controllers/admin_bitly.php @@ -81,9 +81,14 @@ class Admin_Bitly_Controller extends Admin_Controller { $view->content->domain = $form->configure_bitly->domain->value; $view->content->valid_config = $valid_config; $view->content->form = $form; + if ($valid_config) { - // @todo Store/get G3's root bit.ly url, only shorten if it hasn't been stored. - $view->content->g3_url = bitly::shorten_url(bitly::build_link()); + $link = ORM::factory("bitly_link")->where("item_id", "=", 1)->find(); + if ($link->loaded()) { + $view->content->g3_url = "http://" . module::get_var("bitly", "domain") . "/$link->hash"; + } else { + $view->content->g3_url = bitly::shorten_url(1); + } } print $view; } diff --git a/3.1/modules/bitly/helpers/bitly.php b/3.1/modules/bitly/helpers/bitly.php index b69f7fe1..276c7796 100644 --- a/3.1/modules/bitly/helpers/bitly.php +++ b/3.1/modules/bitly/helpers/bitly.php @@ -165,19 +165,17 @@ class bitly_Core { return $response; } - static function build_link($path='/') { - $protocol = strtolower(substr($_SERVER["SERVER_PROTOCOL"], 0, 5)) == 'https' ? 'https' : 'http'; - return url::site($path, $protocol); - } - /** * Shorten a Gallery URL - * @param string $long_url + * @param int $item_id * @param string $format - * @return string + * @return mixed string|false */ - static function shorten_url($long_url, $format='json') { + static function shorten_url($item_id, $format='json') { + $item = ORM::factory("item", $item_id); $short_url = ''; + $long_url = url::abs_site($item->relative_url_cache); + $parameters = array( "login" => module::get_var("bitly", "login"), 'apiKey' => module::get_var("bitly", "api_key"), @@ -185,73 +183,31 @@ class bitly_Core { 'domain' => module::get_var("bitly", "domain"), 'format' => $format, ); + $request = self::_build_http_request('shorten', $parameters); $response = self::_http_post($request, self::$api_host); - $json_decoded = json_decode($response->body[0]); - if ('OK' == $json_decoded->status_txt) { - // Save the original item id, the hash, and possibly the global hash, to the database - $short_url = $json_decoded->data->url; - $hash = $json_decoded->data->hash; - $global_hash = $json_decoded->data->global_hash; - $new_hash = $json_decoded->data->new_hash; - message::success("The $long_url has been shortened to $short_url"); + $json_response = json_decode($response->body[0]); + + if ('OK' == $json_response->status_txt) { + $short_url = $json_response->data->url; + // Save the link hash to the database + $link = ORM::factory("bitly_link"); + $link->item_id = $item_id; + $link->hash = $json_response->data->hash; + //$link->global_hash = $json_response->data->global_hash; + //$new_hash = $json_response->data->new_hash; + $link->owner_id = $item->owner_id; + $link->save(); + + message::success("$long_url has been shortened to $short_url"); + + return $json_response->data->url; + } else { - message::error("Unable to shorten the url"); + message::error("Unable to shorten $long_url"); // @todo log the error + return false; } - return $short_url; } - /** - * returns expanded url - * { - "status_code": 200, - "data": { - "expand": [ - { - "short_url": "http://tcrn.ch/a4MSUH", - "global_hash": "bWw49z", - "long_url": "http://www.techcrunch.com/2010/01/29/windows-mobile-foursquare/", - "user_hash": "a4MSUH" - }, - { - "short_url": "http://bit.ly/1YKMfY", - "global_hash": "1YKMfY", - "long_url": "http://betaworks.com/", - "user_hash": "1YKMfY" - }, - { - "long_url": "http://www.scotster.com/qf/?1152", - "global_hash": "lLWr", - "hash": "j3", - "user_hash": "j3" - }, - { - "hash": "a35.", - "error": "NOT_FOUND" - } - ] - }, - "status_txt": "OK" - } - */ - /** - * - * @param $short_url - * @param $hash - * @param $format - * @return - */ - static function expand_url($short_url, $hash=null, $format='json') { - $parameters = array( - "login" => module::get_var("bitly", "login"), - 'apiKey' => module::get_var("bitly", "api_key"), - 'shortUrl' => $short_url, - 'hash' => $hash, - ); - $request = self::_build_http_request('expand', $parameters); - $response = self::_http_post($http_request, self::$api_host); - return $response; - } - } diff --git a/3.1/modules/bitly/helpers/bitly_event.php b/3.1/modules/bitly/helpers/bitly_event.php index 49ea72a6..3701df8e 100644 --- a/3.1/modules/bitly/helpers/bitly_event.php +++ b/3.1/modules/bitly/helpers/bitly_event.php @@ -28,15 +28,13 @@ class bitly_event_Core { static function site_menu($menu, $theme) { $item = $theme->item(); - if ($item && $item->type == "photo") { - $menu->get("options_menu") - ->append(Menu::factory("link") - ->id("bitly") - ->label(t("Shorten Link with bit.ly")) - ->url(url::site("bitly/shorten_link/$item->id?csrf=$theme->csrf")) - ->css_id("g-bitly-link") - ->css_class("g-print-bitly-link ui-icon-print")); - } + $menu->get("options_menu") + ->append(Menu::factory("link") + ->id("bitly") + ->label(t("Shorten Link with bit.ly")) + ->url(url::site("bitly/shorten/$item->id?csrf=$theme->csrf")) + ->css_id("g-bitly-link") + ->css_class("g-bitly-shorten ui-icon-link")); } static function context_menu($menu, $theme, $item) { @@ -44,7 +42,7 @@ class bitly_event_Core { ->append(Menu::factory("link") ->id("bitly") ->label(t("Shorten Link with bit.ly")) - ->url(url::site("bitly/shorten_link/$item->id?csrf=$theme->csrf")) - ->css_class("g-bitly-link ui-icon-link")); + ->url(url::site("bitly/shorten/$item->id?csrf=$theme->csrf")) + ->css_class("g-bitly-shorten ui-icon-link")); } } diff --git a/3.1/modules/bitly/models/bitly.php b/3.1/modules/bitly/models/bitly.php deleted file mode 100644 index a1b68600..00000000 --- a/3.1/modules/bitly/models/bitly.php +++ /dev/null @@ -1,29 +0,0 @@ - Date: Sun, 26 Dec 2010 06:24:15 +0800 Subject: [PATCH 16/17] Store shortened bit.ly hashes locally. Implemented site menu's shorten link, context menu's not working yet. (missed adding the controller in original commit) --- 3.1/modules/bitly/controllers/bitly.php | 43 +++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 3.1/modules/bitly/controllers/bitly.php diff --git a/3.1/modules/bitly/controllers/bitly.php b/3.1/modules/bitly/controllers/bitly.php new file mode 100644 index 00000000..608918d3 --- /dev/null +++ b/3.1/modules/bitly/controllers/bitly.php @@ -0,0 +1,43 @@ +relative_url_cache)); + } + +} \ No newline at end of file From 3f96ef94db39ac1f177800a7ed5867a17ab86b38 Mon Sep 17 00:00:00 2001 From: Chad Kieffer Date: Sun, 26 Dec 2010 06:37:32 +0800 Subject: [PATCH 17/17] Hooked up shorten link for contextual menu. --- 3.1/modules/bitly/js/bitly.js | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/3.1/modules/bitly/js/bitly.js b/3.1/modules/bitly/js/bitly.js index 35bcd58b..96dcb427 100644 --- a/3.1/modules/bitly/js/bitly.js +++ b/3.1/modules/bitly/js/bitly.js @@ -1,8 +1,6 @@ $(document).ready(function() { - $(".g-bitly-link").click(function(e) { + $(".g-bitly-shorten").click(function(e) { e.preventDefault(); - return; + return window.location = ($(this).attr("href")); }); }); - -