Changeset 1238

Timestamp:

12/09/08 22:54:45 (4 years ago)

Author:

EugenMayer

Message:

Item373: Renaming plugin, generelizing use to export any cookie by name

Location:

trunk/ExportCookiePlugin

Files:

• . (moved) (moved from trunk/DrupalConSidExportPlugin)
• data/System/ExportCookiePlugin.txt (moved) (moved from trunk/DrupalConSidExportPlugin/data/System/DrupalConSidExportPlugin.txt) (1 diff)
• lib/Foswiki/Plugins/ExportCookiePlugin (moved) (moved from trunk/DrupalConSidExportPlugin/lib/Foswiki/Plugins/DrupalConSidExportPlugin)
• lib/Foswiki/Plugins/ExportCookiePlugin/Config.spec (modified) (1 diff)
• lib/Foswiki/Plugins/ExportCookiePlugin/MANIFEST (modified) (1 diff)
• lib/Foswiki/Plugins/ExportCookiePlugin/build.pl (modified) (1 diff)
• lib/Foswiki/Plugins/ExportCookiePluginPlugin.pm (moved) (moved from trunk/DrupalConSidExportPlugin/lib/Foswiki/Plugins/DrupalConSidExportPlugin.pm) (3 diffs)

trunk/ExportCookiePlugin/data/System/ExportCookiePlugin.txt

@@ -1 +1 @@
 ---+!! <nop>%TOPIC%
 
-_This Drupal-Connector exports the SID of drupal and makes it available in Foswiki_
+Exports the value of a Cookie into the Foswiki variable <verbatim>%EXPORTCOOKIE%</verbatim>
 
 %TOC%
 
 ---++ USAGE
-Use the macro <verbatim>%DRUPALSID%</verbatim> to display the sid. You can use this in links or further pugins.
+Use the macro <verbatim>%EXPORTCOOKIE%</verbatim> to display the value. You can use this in links or further pugins.
 
 ---++ Plugin Settings
-
-Plugin settings are stored as preferences variables. To reference a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, i.e. ==%<nop>NEWPLUGIN_SHORTDESCRIPTION%==
-
-   * You need to set the Drupal->SessionHash string in the configure script of Foswiki. You find this hash in your Drupal installation. Please consider the Drupal documentation
-      * Hint: You can find the hash by easy checking your cookies when logged in in drupal.
+   * you need to set the CookieName in the Foswiki configure-system
 
 ---++ Plugin Installation Instructions
-
-__Note:__ You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the TWiki server. 
-
-   * Download the ZIP file from the Plugin Home (see below)
-   * Unzip ==%TOPIC%.zip== in your twiki installation directory. Content:
-     | *File:* | *Description:* |
-     | ==data/System/%TOPIC%.txt== | Plugin topic |
-     | ==data/System/%TOPIC%.txt,v== | Plugin topic repository |
-     | ==lib/Foswiki/Plugins/%TOPIC%.pm== | Plugin Perl module |
-
+   * just use the installer attached to the topic or even easier, use the configure-system/Extension to easy install it trough an user-interface
 ---++ Plugin Info
 
-|  Plugin Author: | Foswiki:Main.EugenMayer|
-|  Copyright: | &copy; 2007, Impressive.media |
+|  Plugin Author: | Foswiki:Main.MayerEugen |
+|  Copyright: | &copy; 2006, Impressive.media |
 |  License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
-|  Plugin Version: | 01 Dez 2008 (V0.1) |
+|  Plugin Version: | 09 Dez 2008 (V0.2) |
 |  Change History: | <!-- versions below in reverse order -->&nbsp; |
-|  01 dEZ 2008: | Initial version |
-|  TWiki Dependency: | $TWiki::Plugins::VERSION 1.1 |
+|  09 Dez 2008: | Renamed plugin to ExportCookiePlugin to generelize the use  |
+|  01 Dez 2008: | Initial version |
+|  Foswiki Dependency: |  |
 |  CPAN Dependencies: | HTTP::Cookies::Find |
-|  Other Dependencies: | none |
+|  Other Dependencies: | |
 |  Perl Version: | 5.005 |
-|  [[Foswiki:Extensions/Benchmark][Benchmarks]]: |  |
-|  Plugin Home: | http://foswiki.org/Extensions/%TOPIC% |
+|  Add-on Home: | http://foswiki.org/Extensions/%TOPIC% |
 |  Feedback: | http://foswiki.org/Extensions/%TOPIC%Dev |
 |  Appraisal: | http://foswiki.org/Extensions/%TOPIC%Appraisal |
 
-__Related Topics:__ [[%SYSTEMWEB%.Plugins][Plugins]], %SYSTEMWEB%.DeveloperDocumentationCategory, %SYSTEMWEB%.AdminDocumentationCategory, %SYSTEMWEB%.DefaultPreferences, %USERSWEB%.SitePreferences
+__Related Topics:__ 

trunk/ExportCookiePlugin/lib/Foswiki/Plugins/ExportCookiePlugin/Config.spec

@@ -1 @@
-# ---+ Drupal
+# ---+ ExportCookie
 # <h2>General Settings</h2>
 
 # **STRING**
-# Path to the themes folder
-
-$Foswiki::cfg{Plugins}{Drupal}{SessionHash}="";
+# Name of the cookie to export
+$Foswiki::cfg{Plugins}{ExportCookie}{CookieName}="";

trunk/ExportCookiePlugin/lib/Foswiki/Plugins/ExportCookiePlugin/MANIFEST

@@ -1 @@
-data/System/DrupalConSidExportPlugin.txt Plugin topic
-lib/Foswiki/Plugins/DrupalConSidExportPlugin.pm Plugin Perl module
+data/System/ExportCookiePlugin.txt Plugin topic
+lib/Foswiki/Plugins/ExportCookiePlugin.pm Plugin Perl module
+lib/Foswiki/Plugins/ExportCookiePlugin/Config.spec 0644
 

trunk/ExportCookiePlugin/lib/Foswiki/Plugins/ExportCookiePlugin/build.pl

@@ -9 +9 @@
 use Foswiki::Contrib::Build;
 
-$build = new Foswiki::Contrib::Build( "DrupalConSidExportPlugin" );
+$build = new Foswiki::Contrib::Build( "ExportCookiePlugin" );
 $build->build($build->{target});
 

trunk/ExportCookiePlugin/lib/Foswiki/Plugins/ExportCookiePluginPlugin.pm

@@ -14 +14 @@
 # http://www.gnu.org/copyleft/gpl.html
 
-package Foswiki::Plugins::DrupalConSidExportPlugin;
+package Foswiki::Plugins::ExportCookiePlugin;
 
 use strict;
@@ -26 +26 @@
 $RELEASE = 'Dakar';
 
-$SHORTDESCRIPTION = 'Saves the current PHPsid generated by drupal and makes it available';
+$SHORTDESCRIPTION = 'Exports the value of a cookie into the Foswiki variable %EXPORTCOOKIE%';
 $NO_PREFS_IN_TOPIC = 1;
 
-$pluginName = 'DrupalConSidExportPlugin';
+$pluginName = 'ExportCookiePlugin';
 
 sub initPlugin {
@@ -42 +42 @@
     $debug = $Foswiki::cfg{Plugins}{PHPsidPlugin}{Debug} || 0;
 
-    Foswiki::Func::registerTagHandler( 'DRUPALSID', \&_DRUPALSID );
+    Foswiki::Func::registerTagHandler( 'EXPORTCOOKIE', \&_GETCOOKIE );
     return 1;
 }
 
-sub _DRUPALSID {
+sub _GETCOOKIEVALUE {
     my($this, $params, $theTopic, $theWeb) = @_;
-        my $twiki = $this->{twiki};
         my $query = Foswiki::Func::getCgiQuery();       
-        my $sid = "";
-        my $drupalSessionHash = $Foswiki::cfg{Plugins}{Drupal}{SessionHash};
+        my $value = "";
+        my $CookieName = $Foswiki::cfg{Plugins}{ExportCookie}{CookieName};
 
         foreach my $name ($query->cookie()) {
-                if($name eq $drupalSessionHash)
+                if($name eq $CookieName)
                 {
-                        $sid = $query->cookie('-name'=>$name);
+                        $value = $query->cookie('-name'=>$name);
                 }
         }
         
-        return $sid;
+        return $value;
 }
 1;