Changeset 4517

Timestamp:

07/21/09 16:08:35 (3 years ago)

Author:

AntonioTerceiro

Message:

Item5692: new release of TopicTranslationsPlugin

• New %CURRENTLANGUAGESUFFIX% macro.
• Porting to Foswiki
• Removed references to TWiki were applicable.
• updated copyright notice
• Adding a proper build system
• Using regular regular expression delimiter in the SCRIPT_ENV test

Location:

trunk/TopicTranslationsPlugin

Files:

• data/System (added)
• data/System/TopicTranslationsPlugin.txt (moved) (moved from trunk/TopicTranslationsPlugin/data/TWiki/TopicTranslationsPlugin.txt) (12 diffs)
• lib/Foswiki (added)
• lib/Foswiki/Plugins (added)
• lib/Foswiki/Plugins/TopicTranslationsPlugin (added)
• lib/Foswiki/Plugins/TopicTranslationsPlugin.pm (moved) (moved from trunk/TopicTranslationsPlugin/lib/TWiki/Plugins/TopicTranslationsPlugin.pm) (19 diffs)
• lib/Foswiki/Plugins/TopicTranslationsPlugin/DEPENDENCIES (added)
• lib/Foswiki/Plugins/TopicTranslationsPlugin/MANIFEST (added)
• lib/Foswiki/Plugins/TopicTranslationsPlugin/build.pl (moved) (moved from trunk/TopicTranslationsPlugin/lib/TWiki/Plugins/TopicTranslationsPlugin/build.pl) (1 diff)
• lib/TWiki/Plugins/TopicTranslationsPlugin/DEPENDENCIES (deleted)
• lib/TWiki/Plugins/TopicTranslationsPlugin/MANIFEST (deleted)

trunk/TopicTranslationsPlugin/data/System/TopicTranslationsPlugin.txt

@@ -1 @@
-%META:TOPICINFO{author="AntonioTerceiro" date="1128026733" format="1.0" version="1.1"}%
+%META:TOPICINFO{author="ProjectContributor" date="1128026733" format="1.0" version="1.1"}%
 ---+!! !TopicTranslationsPlugin
 
@@ -16 +16 @@
 Each web that is going to use !TopicTranslationsPlugin must define a variable named
 =%<nop/>TOPICTRANSLATIONS%=, which must contains a comma-delimited list of language
-code. =%<nop/>TOPICTRANSLATIONS%= can be defined TWiki-wide, which means that those
-languages will be used for the entire TWiki installation. It can also be defined
+code. =%<nop/>TOPICTRANSLATIONS%= can be defined system-wide, which means that those
+languages will be used for the entire site. It can also be defined
 per user. If none of th above is set, the plugin setting for !TopicTranslationsPlugin
 with the same name (=%<nop/>TOPICTRANSLATIONS%=) will be used as a default.
@@ -70 +70 @@
 The language detected for the current topic (based on the current topic's name suffix).
 
+---+++ =%<nop/>CURRENTLANGUAGESUFFIX%=
+
+The language suffix of the current topic (empty if the current topic is in the
+default language, since the default language has not suffix). This is useful
+in menus to create links to fixed topics in the current language. Example:
+
+<verbatim>
+  <a href="%SCRIPTURL{view}%/%WEB%/SomeTopic%CURRENTLANGUAGESUFFIX%"></a>
+</verbatim>
+
 ---+++=%<nop/>DEFAULTLANGUAGE%= 
 
@@ -109 +119 @@
 
 It's useful when used in conjuntcion with a view VIEW_TEMPLATE setting or some
-similar way of making TWiki-editable custom layouts (like the obsolete
-TWiki:Main/FreeSkin), or even site-specific custom skins.
+similar way of making user-editable custom layouts (like the obsolete
+[[TWiki:Main/FreeSkin][FreeSkin]]), or even site-specific custom skins.
 
 %RED% __Warnings:__ %ENDCOLOR%
@@ -116 +126 @@
    * This tag is a workaround for sites that want to display user-written
      different translations of some text based on the current topic's language,
-     while TWiki does not provide a standard way to do that in its core (what
-     is mainly [[TWiki:Main/AntonioTerceiro][my]] fault).
+     while Foswiki does not provide a standard way to do that in its core.
    * This tag is also somewhat conflicting with core's %<nop/>MAKETEXT{}%. The
-     difference is that MAKETEXT uses TWiki-detected language and
-     TRANSLATEMESSAGE uses !TopicTranslationsPlugin-detected language, which
-     may be different in some casse.
+     difference is that MAKETEXT uses system-detected language (e.g. detected
+     from the browser, or set explicitly by the user) and TRANSLATEMESSAGE uses
+     !TopicTranslationsPlugin-detected language (detected from the topic name),
+     which may be different in some casse.
 
 ---++ Automatic Redirection
@@ -144 +154 @@
 from =no=, =off= and =0=).
 
-__Note:__ in TWiki:Codev/CairoRelease, to make this work you'll have to apply the
-following patch to =TWiki/Func.pm= module (got from TWiki's Subversion repository): 
+<blockquote>
+__Note:__ in older TWiki releases, such as TWiki:Codev/CairoRelease, to make
+this work you'll have to apply the following patch to =TWiki/Func.pm= module
+(got from TWiki's Subversion repository): 
 
 <verbatim>
---- /var/lib/twiki/lib/TWiki/Func.pm    2005-07-02 13:33:46.893777128 -0300
+--- /var/lib/twiki/lib/Foswiki/Func.pm    2005-07-02 13:33:46.893777128 -0300
 +++ Func.pm     2005-07-02 13:37:22.187047576 -0300
 @@ -407,8 +407,9 @@
@@ -163 +175 @@
  # =========================
 </verbatim>
+</blockquote>
 
 ---++ Examples
@@ -193 +206 @@
 ---++ 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 server where TWiki is running. 
+__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 server where Foswiki is running. 
 
    * Download the ZIP file from the Plugin web (see below)
@@ -201 +214 @@
      | ==data/System/%TOPIC%.txt,v== | Plugin topic repository |
      | ==lib/Foswiki/Plugins/%TOPIC%.pm== | Plugin Perl module |
-   * (Dakar) Visit =configure= in your TWiki installation, and enable the plugin in the {Plugins} section.
+   * Visit =configure= in your Foswiki installation, and enable the plugin in the {Plugins} section.
    * Test if the installation was successful:
       * see the examples [[#Examples][above]]
@@ -207 +220 @@
 ---++ Plugin Info
 
-|  Plugin Author: | TWiki:Main.AntonioTerceiro |
-|  Copyright: | &copy; 2006, TWiki:Main.AntonioTerceiro |
+|  Plugin Author: | Foswiki:Main.AntonioTerceiro |
+|  Copyright: | Copyright &copy; 2005-2009, Foswiki:Main.AntonioTerceiro |
 |  License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
 |  Plugin Version: | 03 Jul 2005 (V1.003) |
@@ -220 +233 @@
 |  02 Jul 2005 | Version =1.002=: major rewrite; documented all (or almost all :)) the code; added selection of available/missing translations; added =missingformat=; added support for custom topics (and webs) in <code>%<nop/>TRANSLATIONS%</code>; added automatic redirection for the "best" translation (detection via =I18N::AcceptLanguage=).  |
 |  19 Jun 2005: | Initial version: =1.001= |
-|  TWiki Dependency: | $TWiki::Plugins::VERSION 1.024 |
+|  Foswiki Dependency: | $Foswiki::Plugins::VERSION 1.024 |
 |  CPAN Dependencies: | =I18N::AcceptLanguage= |
 |  Other Dependencies: | none |
@@ -229 +242 @@
 __Related Topics:__ %SYSTEMWEB%.DefaultPreferences, %USERSWEB%.SitePreferences, [[%SYSTEMWEB%.Plugins][Plugins]]
 
--- TWiki:Main.AntonioTerceiro - 03 Jul 2005
-
+-- Foswiki:Main.AntonioTerceiro - 21 Jul 2009
+

trunk/TopicTranslationsPlugin/lib/Foswiki/Plugins/TopicTranslationsPlugin.pm

@@ -1 +1 @@
 # Plugin for Foswiki - The Free and Open Source Wiki, http://foswiki.org/
 #
-# Copyright (C) 2005 Antonio S. de A. Terceiro, asaterceiro@inf.ufrgs.br
+# Copyright (C) 2005-2009 Antonio Terceiro, terceiro@softwarelivre.org
 #
 # This program is free software; you can redistribute it and/or
@@ -15 +15 @@
 
 # =========================
-package TWiki::Plugins::TopicTranslationsPlugin;
+package Foswiki::Plugins::TopicTranslationsPlugin;
 
 # =========================
@@ -30 +30 @@
 use I18N::AcceptLanguage;
 
-# This should always be $Rev$ so that TWiki can determine the checked-in
+# This should always be $Rev$ so that Foswiki can determine the checked-in
 # status of the plugin. It is used by the build automation tools, so
 # you should leave it alone.
@@ -47 +47 @@
 
     # check for Plugins.pm versions
-    if( $TWiki::Plugins::VERSION < 1.024 ) {
-        TWiki::Func::writeWarning( "Version mismatch between $pluginName and Plugins.pm" );
+    if( $Foswiki::Plugins::VERSION < 1.024 ) {
+        Foswiki::Func::writeWarning( "Version mismatch between $pluginName and Plugins.pm" );
         return 0;
     }
 
     # Get plugin debug flag
-    $debug = TWiki::Func::getPluginPreferencesFlag( "DEBUG" );
+    $debug = Foswiki::Func::getPluginPreferencesFlag( "DEBUG" );
 
     # those should be preferably set in a per web basis. Defaults to the
     # corresponding plugin setting (or "en" if someone messes with it)
-    my $trans = TWiki::Func::getPreferencesValue("TOPICTRANSLATIONS") || TWiki::Func::getPluginPreferencesValue("TOPICTRANSLATIONS") || "en";
+    my $trans = Foswiki::Func::getPreferencesValue("TOPICTRANSLATIONS") || Foswiki::Func::getPluginPreferencesValue("TOPICTRANSLATIONS") || "en";
     @translations = split(/,\s*/,$trans);
-    $redirectMethod = TWiki::Func::getPreferencesValue("REDIRECTMETHOD") || TWiki::Func::getPluginPreferencesValue("REDIRECTMETHOD") || "http";
-    $userLanguage = TWiki::Func::getPreferencesValue("LANGUAGE") || "en";    
+    $redirectMethod = Foswiki::Func::getPreferencesValue("REDIRECTMETHOD") || Foswiki::Func::getPluginPreferencesValue("REDIRECTMETHOD") || "http";
+    $userLanguage = Foswiki::Func::getPreferencesValue("LANGUAGE") || "en";    
 
     # first listed language is the default one:
@@ -74 +74 @@
 
     # must I redirect to the best available translation?
-    my $mustRedirect = (! TWiki::Func::getPluginPreferencesFlag("DISABLE_AUTOMATIC_REDIRECTION"));
+    my $mustRedirect = (! Foswiki::Func::getPluginPreferencesFlag("DISABLE_AUTOMATIC_REDIRECTION"));
     checkRedirection() if $mustRedirect;
 
     # Plugin correctly initialized
-    TWiki::Func::writeDebug( "- TWiki::Plugins::${pluginName}::initPlugin( $web.$topic ) is OK" ) if $debug;
+    Foswiki::Func::writeDebug( "- Foswiki::Plugins::${pluginName}::initPlugin( $web.$topic ) is OK" ) if $debug;
     return 1;
 }
@@ -86 +86 @@
 ### my ( $text, $topic, $web ) = @_;   # do not uncomment, use $_[0], $_[1]... instead
 
-    TWiki::Func::writeDebug( "- ${pluginName}::beforeCommonTagsHandler( $_[2].$_[1] )" ) if $debug;
+    Foswiki::Func::writeDebug( "- ${pluginName}::beforeCommonTagsHandler( $_[2].$_[1] )" ) if $debug;
 
     # handle all INCLUDETRANSLATION tags:
@@ -96 +96 @@
 ### my ( $text, $topic, $web ) = @_;   # do not uncomment, use $_[0], $_[1]... instead
 
-    TWiki::Func::writeDebug( "- ${pluginName}::commonTagsHandler( $_[2].$_[1] )" ) if $debug;
+    Foswiki::Func::writeDebug( "- ${pluginName}::commonTagsHandler( $_[2].$_[1] )" ) if $debug;
 
     # handle our common tags:
     $_[0] =~ s/%TRANSLATIONS({(.*?)})?%/&handleTranslations($2)/ge;
     $_[0] =~ s/%CURRENTLANGUAGE%/&currentLanguage/ge;
+    $_[0] =~ s/%CURRENTLANGUAGESUFFIX%/&currentLanguageSuffix/ge;
     $_[0] =~ s/%DEFAULTLANGUAGE%/$defaultLanguage/ge;
     $_[0] =~ s/%BASETRANSLATION({(.*?)})?%/&handleBaseTranslation($2)/ge;
@@ -106 +107 @@
 }
 
-# transform a language code into a suitable suffix for TWiki topics,
-# by capitalizing the first letter and all the others lowercase.
+# transform a language code into a suitable suffix for topics, by capitalizing
+# the first letter and all the others lowercase.
 # Examples:
 #   pt-br -> Ptbr     EN -> En
@@ -146 +147 @@
 }
 
+# returns the current language suffix, or '' (empty string) if the current
+# language is the default one
+sub currentLanguageSuffix {
+  my $lang = currentLanguage();
+  return ($lang eq $defaultLanguage) ? '' : normalizeLanguageName($lang);
+}
+
 # list the translations of the current topic (or to that one passed as an
 # argument). Depending on the arguments to the %TRANSLATIONS% tag, many options
@@ -157 +165 @@
 
     # format for the items:
-    my $format = TWiki::Func::extractNameValuePair($params, "format") || "[[\$web.\$translation][\$language]]";
-    my $missingFormat = TWiki::Func::extractNameValuePair($params, "missingformat") || $format;
+    my $format = Foswiki::Func::extractNameValuePair($params, "format") || "[[\$web.\$translation][\$language]]";
+    my $missingFormat = Foswiki::Func::extractNameValuePair($params, "missingformat") || $format;
     
     # other stuff:
-    my $userSeparator = TWiki::Func::extractNameValuePair($params, "separator") || " ";
+    my $userSeparator = Foswiki::Func::extractNameValuePair($params, "separator") || " ";
 
     # 
-    my $theTopic = TWiki::Func::extractNameValuePair($params) || TWiki::Func::extractNameValuePair($params,"topic") || $topic;
+    my $theTopic = Foswiki::Func::extractNameValuePair($params) || Foswiki::Func::extractNameValuePair($params,"topic") || $topic;
     my $theWeb;
     if ($theTopic =~ m/^([^.]+)\.([^.]+)/) {
@@ -176 +184 @@
 
     # find out which translations we must list:
-    my $which = TWiki::Func::extractNameValuePair($params, "which") || "all";
+    my $which = Foswiki::Func::extractNameValuePair($params, "which") || "all";
     my @whichTranslations;
     if ($which eq "available") {
@@ -202 +210 @@
 
     # wheter to use the format for available translations or for missing ones:
-    my $result = (TWiki::Func::topicExists($web, $translationTopic))?($format):($missingFormat);
+    my $result = (Foswiki::Func::topicExists($web, $translationTopic))?($format):($missingFormat);
 
     # substitute the variables:
@@ -220 +228 @@
     my $theLang = currentLanguage();
     
-    my $theTopic = TWiki::Func::extractNameValuePair($params);
+    my $theTopic = Foswiki::Func::extractNameValuePair($params);
     my $theWeb;
     if ($theTopic =~ m/^([^.]+)\.([^.]+)/) {
@@ -236 +244 @@
 
     # undef is ok, meaning current revision:
-    my $theRev = TWiki::Func::extractNameValuePair($params, "rev");
+    my $theRev = Foswiki::Func::extractNameValuePair($params, "rev");
 
     my $args = "\"$theWeb.$theTopic\"";
@@ -268 +276 @@
     my $script = $ENV{SCRIPT_NAME} || '/view'; 
 
-    if (($script =~ m#/view(auth)?$#) and (! $ENV{QUERY_STRING})) {
-        my $query = TWiki::Func::getCgiQuery();
+    if (($script =~ m/\/view(auth)?$/) and (! $ENV{QUERY_STRING})) {
+        my $query = Foswiki::Func::getCgiQuery();
     
         # several checks
         my $baseTopicName = findBaseTopicName();
-        my $baseUrl = TWiki::Func::getViewUrl($web, $baseTopicName);
-        my $editUrl = TWiki::Func::getScriptUrl($web, $baseTopicName, 'edit');
+        my $baseUrl = Foswiki::Func::getViewUrl($web, $baseTopicName);
+        my $editUrl = Foswiki::Func::getScriptUrl($web, $baseTopicName, 'edit');
         my $origin = $query->referer() || '';
         
@@ -289 +297 @@
               # actually do the redirect:
               my $bestTranslationTopic = findBaseTopicName() . (($best eq $defaultLanguage)?'':(normalizeLanguageName($best)));
-              my $url = TWiki::Func::getViewUrl($web,$bestTranslationTopic);
-              TWiki::Func::redirectCgiQuery($query, $url);
+              my $url = Foswiki::Func::getViewUrl($web,$bestTranslationTopic);
+              Foswiki::Func::redirectCgiQuery($query, $url);
             }
         }
@@ -326 +334 @@
         
         # is that translation available?
-        $exists = TWiki::Func::topicExists($web, $theTopic . $norm);
+        $exists = Foswiki::Func::topicExists($web, $theTopic . $norm);
 
         # what kind (available or not) are we looking for?
@@ -339 +347 @@
 sub handleBaseTranslation {
     my $params = shift;
-    my $myTopic = TWiki::Func::extractNameValuePair($params, "topic") || $topic;
+    my $myTopic = Foswiki::Func::extractNameValuePair($params, "topic") || $topic;
     return findBaseTopicName($myTopic);
 }
@@ -347 +355 @@
   my $params = shift;
   my $lang = currentLanguage();
-  return (TWiki::Func::extractNameValuePair($params, $lang));
+  return (Foswiki::Func::extractNameValuePair($params, $lang));
 }
 

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

@@ -9 +9 @@
 }
 
-use TWiki::Contrib::Build;
+use Foswiki::Contrib::Build;
 
 # Create the build object
-$build = new TWiki::Contrib::Build( 'TopicTranslationsPlugin' );
+$build = new Foswiki::Contrib::Build( 'TopicTranslationsPlugin' );
 
 # Build the target on the command line, or the default target