From: jervfors <jervfors@7612ce4b-ef26-0410-bec9-ea0150e637f0>
Date: Sun, 3 Apr 2005 19:36:11 +0000 (+0000)
Subject: phpDoc and i18n fixes.
X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=commitdiff_plain;h=793566f084fbb48ab6ec356eb7d4bb76b139e719

phpDoc and i18n fixes.
Moving functions from "setup.php" to "functions.php".
Fixing notice in "mailout.php".
Fixing paths.


git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@9180 7612ce4b-ef26-0410-bec9-ea0150e637f0
---

diff --git a/plugins/listcommands/functions.php b/plugins/listcommands/functions.php
new file mode 100644
index 00000000..7028ed2f
--- /dev/null
+++ b/plugins/listcommands/functions.php
@@ -0,0 +1,92 @@
+<?php
+
+/**
+ * functions.php
+ *
+ * Copyright (c) 1999-2005 The SquirrelMail Project Team
+ * Licensed under the GNU GPL. For full terms see the file COPYING.
+ *
+ * Implementation of RFC 2369 for SquirrelMail.
+ * When viewing a message from a mailinglist complying with this RFC,
+ * this plugin displays a menu which gives the user a choice of mailinglist
+ * commands such as (un)subscribe, help and list archives.
+ *
+ * @version $Id$
+ * @package plugins
+ * @subpackage listcommands
+ */
+
+function plugin_listcommands_menu_do() {
+    global $passed_id, $passed_ent_id, $color, $mailbox, $message, $startMessage;
+
+    /**
+     * Array of commands we can deal with from the header. The Reply option
+     * is added later because we generate it using the Post information.
+     */
+    $fieldsdescr = listcommands_fieldsdescr();
+    $output = array();
+
+    foreach ($message->rfc822_header->mlist as $cmd => $actions) {
+
+        /* I don't know this action... skip it */
+        if ( !array_key_exists($cmd, $fieldsdescr) ) {
+            continue;
+        }
+
+        /* proto = {mailto,href} */
+        $proto = array_shift(array_keys($actions));
+        $act   = array_shift($actions);
+
+        if ($proto == 'mailto') {
+
+            if (($cmd == 'post') || ($cmd == 'owner')) {
+                $url = 'src/compose.php?'.
+                    (isset($startMessage)?'startMessage='.$startMessage.'&amp;':'');
+            } else {
+                $url = "plugins/listcommands/mailout.php?action=$cmd&amp;";
+            }
+            $url .= 'send_to=' . strtr($act,'?','&');
+
+            $output[] = makeComposeLink($url, $fieldsdescr[$cmd]);
+
+            if ($cmd == 'post') {
+                if (!isset($mailbox))
+                    $mailbox = 'INBOX';
+                $url .= '&amp;passed_id='.$passed_id.
+                    '&amp;mailbox='.urlencode($mailbox).
+                    (isset($passed_ent_id)?'&amp;passed_ent_id='.$passed_ent_id:'');
+                $url .= '&amp;smaction=reply';
+
+                $output[] = makeComposeLink($url, $fieldsdescr['reply']);
+            }
+        } else if ($proto == 'href') {
+            $output[] = '<a href="' . $act . '" target="_blank">'
+                . $fieldsdescr[$cmd] . '</a>';
+        }
+    }
+
+    if (count($output) > 0) {
+        echo '<tr>' .
+            html_tag('td', '<b>' . _("Mailing List") . ':&nbsp;&nbsp;</b>',
+                    'right', '', 'valign="middle" width="20%"') . "\n" .
+            html_tag('td', '<small>' . implode('&nbsp;|&nbsp;', $output) . '</small>',
+                    'left', $color[0], 'valign="middle" width="80%"') . "\n" .
+            '</tr>';
+    }
+}
+
+/**
+ * Returns an array with the actions as translated strings.
+ * @return array action as key, translated string as value
+ */
+function listcommands_fieldsdescr() {
+    return array('post'   => _("Post to List"),
+            'reply'       => _("Reply to List"),
+            'subscribe'   => _("Subscribe"),
+            'unsubscribe' => _("Unsubscribe"),
+            'archive'     => _("List Archives"),
+            'owner'       => _("Contact Listowner"),
+            'help'        => _("Help"));
+}
+
+?>
\ No newline at end of file
diff --git a/plugins/listcommands/index.php b/plugins/listcommands/index.php
index 41ebea82..83c7332c 100644
--- a/plugins/listcommands/index.php
+++ b/plugins/listcommands/index.php
@@ -1,19 +1,19 @@
 <?php
 
-   /**
-    **  index.php -- Displays the main frameset
-    **
-    **  Copyright (c) 1999-2005 The SquirrelMail Project Team
-    **  Licensed under the GNU GPL. For full terms see the file COPYING.
-    **
-    **  Redirects to the login page.
-    **
-    **  $Id$
-    * @package plugins
-    * @subpackage listcommands
-    **/
+/**
+ * index.php -- Displays the main frameset
+ *
+ * Copyright (c) 1999-2005 The SquirrelMail Project Team
+ * Licensed under the GNU GPL. For full terms see the file COPYING.
+ *
+ * Redirects to the login page.
+ *
+ * @version $Id$
+ * @package plugins
+ * @subpackage listcommands
+ */
 
-   header("Location:../../src/login.php\n\n");
-   exit();
+header("Location:../../src/login.php\n\n");
+exit();
 
 ?>
\ No newline at end of file
diff --git a/plugins/listcommands/mailout.php b/plugins/listcommands/mailout.php
index c39f1d9d..c85d2680 100644
--- a/plugins/listcommands/mailout.php
+++ b/plugins/listcommands/mailout.php
@@ -1,11 +1,12 @@
 <?php
+
 /**
  * mailout.php
  *
  * Copyright (c) 1999-2005 The SquirrelMail Project Team
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
- * $Id$
+ * @version $Id$
  * @package plugins
  * @subpackage listcommands
  */
@@ -20,8 +21,7 @@ include_once(SM_PATH . 'include/load_prefs.php');
 include_once(SM_PATH . 'functions/html.php');
 require_once(SM_PATH . 'functions/identity.php');
 require_once(SM_PATH . 'functions/forms.php');
-
-displayPageHeader($color, $mailbox);
+include_once(SM_PATH . 'plugins/listcommands/functions.php');
 
 /* get globals */
 sqgetGlobalVar('mailbox', $mailbox, SQ_GET);
@@ -30,29 +30,31 @@ sqgetGlobalVar('subject', $subject, SQ_GET);
 sqgetGlobalVar('body',    $body,    SQ_GET);
 sqgetGlobalVar('action',  $action,  SQ_GET);
 
+displayPageHeader($color, $mailbox);
+$fieldsdescr = listcommands_fieldsdescr();
+
 echo html_tag('p', '', 'left' ) .
-html_tag( 'table', '', 'center', $color[0], 'border="0" width="75%"' ) . "\n" .
+    html_tag( 'table', '', 'center', $color[0], 'border="0" width="75%"' ) . "\n" .
     html_tag( 'tr',
-        html_tag( 'th', _("Mailinglist") . ' ' . _($action), '', $color[9] )
-    ) .
+            html_tag( 'th', _("Mailinglist") . ': ' . $fieldsdescr[$action], '', $color[9] )
+            ) .
     html_tag( 'tr' ) .
     html_tag( 'td', '', 'left' );
 
 switch ( $action ) {
-case 'help':
-    $out_string = _("This will send a message to %s requesting help for this list. You will receive an emailed response at the address below.");
-    break;
-case 'subscribe':
-    $out_string = _("This will send a message to %s requesting that you will be subscribed to this list. You will be subscribed with the address below.");
-    break;
-case 'unsubscribe':
-    $out_string = _("This will send a message to %s requesting that you will be unsubscribed from this list. It will try to unsubscribe the adress below.");
+    case 'help':
+        $out_string = _("This will send a message to %s requesting help for this list. You will receive an emailed response at the address below.");
+        break;
+    case 'subscribe':
+        $out_string = _("This will send a message to %s requesting that you will be subscribed to this list. You will be subscribed with the address below.");
+        break;
+    case 'unsubscribe':
+        $out_string = _("This will send a message to %s requesting that you will be unsubscribed from this list. It will try to unsubscribe the adress below.");
 }
 
-printf( $out_string, htmlspecialchars($send_to) );
-
-echo addForm('../../src/compose.php', 'post');
+printf($out_string, '&quot;' . htmlspecialchars($send_to) . '&quot;');
 
+echo addForm(SM_PATH . 'src/compose.php', 'post');
 
 $idents = get_identities();
 
@@ -63,20 +65,20 @@ if (count($idents) > 1) {
     foreach($idents as $nr=>$data) {
         echo '<option value="' . $nr . '">' .
             htmlspecialchars(
-                $data['full_name'].' <'.
-                $data['email_address'] . ">\n");
+                    $data['full_name'].' <'.
+                    $data['email_address'] . ">\n");
     }
     echo '</select>' . "\n" ;
 } else {
     echo htmlspecialchars('"'.$idents[0]['full_name'].'" <'.$idents[0]['email_address'].'>');
 }
 
-echo '<br />'
-. addHidden('send_to', $send_to)
-. addHidden('subject', $subject)
-. addHidden('body', $body)
-. addHidden('mailbox', $mailbox)
-. addSubmit(_("Send Mail"), 'send')
-. '<br /><br /></center>'
-. '</form></td></tr></table></p></body></html>';
-?>
\ No newline at end of file
+echo '<br />' .
+    addHidden('send_to', $send_to) .
+    addHidden('subject', $subject) .
+    addHidden('body', $body) .
+    addHidden('mailbox', $mailbox) .
+    addSubmit(_("Send Mail"), 'send');
+?>
+<br /><br /></center>
+</form></td></tr></table></p></body></html>
\ No newline at end of file
diff --git a/plugins/listcommands/setup.php b/plugins/listcommands/setup.php
index 523940fe..ac5b5a27 100644
--- a/plugins/listcommands/setup.php
+++ b/plugins/listcommands/setup.php
@@ -11,7 +11,7 @@
  * this plugin displays a menu which gives the user a choice of mailinglist
  * commands such as (un)subscribe, help and list archives.
  *
- * $Id$
+ * @version $Id$
  * @package plugins
  * @subpackage listcommands
  */
@@ -26,68 +26,8 @@ function squirrelmail_plugin_init_listcommands () {
 }
 
 function plugin_listcommands_menu() {
-    global $passed_id, $passed_ent_id, $color, $mailbox, $message, $startMessage;
-
-    /**
-     * Array of commands we can deal with from the header. The Reply option
-     * is added later because we generate it using the Post information.
-     */
-    $fieldsdescr = array('post'        => _("Post to List"),
-                         'reply'       => _("Reply to List"),
-                         'subscribe'   => _("Subscribe"),
-                         'unsubscribe' => _("Unsubscribe"),
-                         'archive'     => _("List Archives"),
-                         'owner'       => _("Contact Listowner"),
-                         'help'        => _("Help"));
-    $output = array();
-
-    foreach ($message->rfc822_header->mlist as $cmd => $actions) {
-
-        /* I don't know this action... skip it */
-        if ( !array_key_exists($cmd, $fieldsdescr) ) {
-            continue;
-        }
-
-        /* proto = {mailto,href} */
-        $proto = array_shift(array_keys($actions));
-        $act   = array_shift($actions);
-
-        if ($proto == 'mailto') {
-
-            if (($cmd == 'post') || ($cmd == 'owner')) {
-                $url = 'src/compose.php?'.
-                (isset($startMessage)?'startMessage='.$startMessage.'&amp;':'');
-            } else {
-                $url = "plugins/listcommands/mailout.php?action=$cmd&amp;";
-            }
-            $url .= 'send_to=' . strtr($act,'?','&');
-
-            $output[] = makeComposeLink($url, $fieldsdescr[$cmd]);
-
-            if ($cmd == 'post') {
-                if (!isset($mailbox))
-                    $mailbox = 'INBOX';
-                $url .= '&amp;passed_id='.$passed_id.
-                        '&amp;mailbox='.urlencode($mailbox).
-                        (isset($passed_ent_id)?'&amp;passed_ent_id='.$passed_ent_id:'');
-                $url .= '&amp;smaction=reply';
-
-                $output[] = makeComposeLink($url, $fieldsdescr['reply']);
-            }
-        } else if ($proto == 'href') {
-            $output[] = '<a href="' . $act . '" target="_blank">'
-                      . $fieldsdescr[$cmd] . '</a>';
-        }
-    }
-
-    if (count($output) > 0) {
-        echo '<tr>';
-        echo html_tag('td', '<b>' . _("Mailing List") . ':&nbsp;&nbsp;</b>',
-                      'right', '', 'valign="middle" width="20%"') . "\n";
-        echo html_tag('td', '<small>' . implode('&nbsp;|&nbsp;', $output) . '</small>',
-                      'left', $color[0], 'valign="middle" width="80%"') . "\n";
-        echo '</tr>';
-    }
+    include_once(SM_PATH . 'plugins/listcommands/functions.php');
+    plugin_listcommands_menu_do();
 }
 
 ?>
\ No newline at end of file