]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - lib/mailbox.php
make PiwikAnalytics work a little nicer
[quix0rs-gnu-social.git] / lib / mailbox.php
index bdc360a35325f485a5bc9f7117bb8607dfde2f67..e1d384a0635207d97e9c04c1482f8d6fa65e05a7 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /**
- * Laconica, the distributed open-source microblogging tool
+ * StatusNet, the distributed open-source microblogging tool
  *
  * common superclass for direct messages inbox and outbox
  *
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  *
  * @category  Message
- * @package   Laconica
- * @author    Evan Prodromou <evan@controlyourself.ca>
- * @copyright 2008 Control Yourself, Inc.
+ * @package   StatusNet
+ * @author    Evan Prodromou <evan@status.net>
+ * @copyright 2008 StatusNet, Inc.
  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
- * @link      http://laconi.ca/
+ * @link      http://status.net/
  */
 
-if (!defined('LACONICA')) {
+if (!defined('STATUSNET') && !defined('LACONICA')) {
     exit(1);
 }
 
-require_once INSTALLDIR.'/lib/personal.php';
-
 define('MESSAGES_PER_PAGE', 20);
 
 /**
  * common superclass for direct messages inbox and outbox
  *
  * @category Message
- * @package  Laconica
- * @author   Evan Prodromou <evan@controlyourself.ca>
+ * @package  StatusNet
+ * @author   Evan Prodromou <evan@status.net>
  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
- * @link     http://laconi.ca/
+ * @link     http://status.net/
  * @see      InboxAction
  * @see      OutboxAction
  */
 
-class MailboxAction extends PersonalAction
+class MailboxAction extends CurrentUserDesignAction
 {
-    /**
-     * output page based on arguments
-     *
-     * @param array $args HTTP arguments (from $_REQUEST)
-     *
-     * @return void
-     */
+    var $page = null;
 
-    function handle($args)
+    function prepare($args)
     {
-        parent::handle($args);
-
-        $nickname = common_canonical_nickname($this->arg('nickname'));
+        parent::prepare($args);
 
-        $user = User::staticGet('nickname', $nickname);
+        $nickname   = common_canonical_nickname($this->arg('nickname'));
+        $this->user = User::staticGet('nickname', $nickname);
+        $this->page = $this->trimmed('page');
 
-        if (!$user) {
-            $this->client_error(_('No such user.'), 404);
-            return;
+        if (!$this->page) {
+            $this->page = 1;
         }
 
-        $cur = common_current_user();
+        common_set_returnto($this->selfUrl());
 
-        if (!$cur || $cur->id != $user->id) {
-            $this->client_error(_('Only the user can read their own mailboxes.'),
-                                403);
-            return;
-        }
-
-        $profile = $user->getProfile();
-
-        if (!$profile) {
-            $this->server_error(_('User has no profile.'));
-            return;
-        }
-
-        $page = $this->trimmed('page');
-
-        if (!$page) {
-            $page = 1;
-        }
-
-        $this->showPage($user, $page);
+        return true;
     }
 
     /**
-     * returns the title of the page
-     *
-     * @param User $user current user
-     * @param int  $page current page
+     * output page based on arguments
      *
-     * @return string localised title of the page
-     */
-
-    function getTitle($user, $page)
-    {
-        return '';
-    }
-
-    /**
-     * instructions for using this page
+     * @param array $args HTTP arguments (from $_REQUEST)
      *
-     * @return string localised instructions for using the page
+     * @return void
      */
 
-    function getInstructions()
+    function handle($args)
     {
-        return '';
-    }
+        parent::handle($args);
 
-    /**
-     * do structured output for the "instructions" are of the page
-     *
-     * @return void
-     */
+        if (!$this->user) {
+            $this->clientError(_('No such user.'), 404);
+            return;
+        }
 
-    function showTop()
-    {
         $cur = common_current_user();
 
-        common_message_form(null, $cur, null);
+        if (!$cur || $cur->id != $this->user->id) {
+            $this->clientError(_('Only the user can read their own mailboxes.'),
+                403);
+            return;
+        }
 
-        $this->views_menu();
+        $this->showPage();
     }
 
-    /**
-     * show a full page of output
-     *
-     * @param User $user The current user
-     * @param int  $page The page the user is on
-     *
-     * @return void
-     */
-
-    function showPage($user, $page)
+    function showLocalNav()
     {
-        common_show_header($this->getTitle($user, $page),
-                           null, null,
-                           array($this, 'showTop'));
-
-        $this->showBox($user, $page);
-
-        common_show_footer();
+        $nav = new PersonalGroupNav($this);
+        $nav->show();
     }
 
-    /**
-     * retrieve the messages appropriate for this mailbox
-     *
-     * Does a query for the right messages
-     *
-     * @param User $user The current user
-     * @param int  $page The page the user is on
-     *
-     * @return Message data object with stream for messages
-     */
-
-    function getMessages($user, $page)
+    function showNoticeForm()
     {
-        return null;
+        $message_form = new MessageForm($this);
+        $message_form->show();
     }
 
-    /**
-     * show the messages for a mailbox in list format
-     *
-     * Includes the pagination links (before, after).
-     *
-     * @param User $user The current user
-     * @param int  $page The page the user is on
-     *
-     * @return void
-     */
-
-    function showBox($user, $page)
+    function showContent()
     {
-        $message = $this->getMessages($user, $page);
+        $message = $this->getMessages();
 
         if ($message) {
-
             $cnt = 0;
-            common_element_start('ul', array('id' => 'messages'));
+            $this->elementStart('div', array('id' =>'notices_primary'));
+            $this->element('h2', null, _('Notices'));
+            $this->elementStart('ul', 'notices');
 
             while ($message->fetch() && $cnt <= MESSAGES_PER_PAGE) {
                 $cnt++;
@@ -200,15 +126,23 @@ class MailboxAction extends PersonalAction
                 $this->showMessage($message);
             }
 
-            common_element_end('ul');
-
-            common_pagination($page > 1, $cnt > MESSAGES_PER_PAGE,
-                              $page, $this->trimmed('action'),
-                              array('nickname' => $user->nickname));
+            $this->elementEnd('ul');
 
+            $this->pagination($this->page > 1, $cnt > MESSAGES_PER_PAGE,
+                              $this->page, $this->trimmed('action'),
+                              array('nickname' => $this->user->nickname));
+            $this->elementEnd('div');
             $message->free();
             unset($message);
         }
+        else {
+            $this->element('p', 'guide', _('You have no private messages. You can send private message to engage other users in conversation. People can send you messages for your eyes only.'));
+        }
+    }
+
+    function getMessages()
+    {
+        return null;
     }
 
     /**
@@ -229,6 +163,9 @@ class MailboxAction extends PersonalAction
     /**
      * show a single message in the list format
      *
+     * XXX: This needs to be extracted out into a MessageList similar
+     * to NoticeList.
+     *
      * @param Message $message the message to show
      *
      * @return void
@@ -236,30 +173,35 @@ class MailboxAction extends PersonalAction
 
     function showMessage($message)
     {
-        common_element_start('li', array('class' => 'message_single',
+        $this->elementStart('li', array('class' => 'hentry notice',
                                          'id' => 'message-' . $message->id));
 
         $profile = $this->getMessageProfile($message);
 
+        $this->elementStart('div', 'entry-title');
+        $this->elementStart('span', 'vcard author');
+        $this->elementStart('a', array('href' => $profile->profileurl,
+                                       'class' => 'url'));
         $avatar = $profile->getAvatar(AVATAR_STREAM_SIZE);
-        common_element_start('a', array('href' => $profile->profileurl));
-        common_element('img', array('src' => ($avatar) ?
-                                    common_avatar_display_url($avatar) :
-                                    common_default_avatar(AVATAR_STREAM_SIZE),
-                                    'class' => 'avatar stream',
+        $this->element('img', array('src' => ($avatar) ?
+                                    $avatar->displayUrl() :
+                                    Avatar::defaultImage(AVATAR_STREAM_SIZE),
+                                    'class' => 'photo avatar',
                                     'width' => AVATAR_STREAM_SIZE,
                                     'height' => AVATAR_STREAM_SIZE,
                                     'alt' =>
                                     ($profile->fullname) ? $profile->fullname :
                                     $profile->nickname));
-        common_element_end('a');
-        common_element('a', array('href' => $profile->profileurl,
-                                  'class' => 'nickname'),
-                       $profile->nickname);
+        $this->element('span', array('class' => 'nickname fn'),
+                            $profile->nickname);
+        $this->elementEnd('a');
+        $this->elementEnd('span');
+
         // FIXME: URL, image, video, audio
-        common_element_start('p', array('class' => 'content'));
-        common_raw($message->rendered);
-        common_element_end('p');
+        $this->elementStart('p', array('class' => 'entry-content'));
+        $this->raw($message->rendered);
+        $this->elementEnd('p');
+        $this->elementEnd('div');
 
         $messageurl = common_local_url('showmessage',
                                        array('message' => $message->id));
@@ -269,18 +211,95 @@ class MailboxAction extends PersonalAction
             preg_match('/^http/', $message->uri)) {
             $messageurl = $message->uri;
         }
-        common_element_start('p', 'time');
-        common_element('a', array('class' => 'permalink',
-                                  'href' => $messageurl,
-                                  'title' => common_exact_date($message->created)),
-                       common_date_string($message->created));
+
+        $this->elementStart('div', 'entry-content');
+        $this->elementStart('a', array('rel' => 'bookmark',
+                                       'class' => 'timestamp',
+                                       'href' => $messageurl));
+        $dt = common_date_iso8601($message->created);
+        $this->element('abbr', array('class' => 'published',
+                                     'title' => $dt),
+                               common_date_string($message->created));
+        $this->elementEnd('a');
+
         if ($message->source) {
-            common_text(_(' from '));
-            $this->source_link($message->source);
+            $this->elementStart('span', 'source');
+            $this->text(_('from'));
+            $this->element('span', 'device', $this->showSource($message->source));
+            $this->elementEnd('span');
+        }
+        $this->elementEnd('div');
+
+        $this->elementEnd('li');
+    }
+
+    /**
+     * Show the page notice
+     *
+     * Shows instructions for the page
+     *
+     * @return void
+     */
+
+    function showPageNotice()
+    {
+        $instr  = $this->getInstructions();
+        $output = common_markup_to_html($instr);
+
+        $this->elementStart('div', 'instructions');
+        $this->raw($output);
+        $this->elementEnd('div');
+    }
+
+    /**
+     * Show the source of the message
+     *
+     * Returns either the name (and link) of the API client that posted the notice,
+     * or one of other other channels.
+     *
+     * @param string $source the source of the message
+     *
+     * @return void
+     */
+
+    function showSource($source)
+    {
+        $source_name = _($source);
+        switch ($source) {
+        case 'web':
+        case 'xmpp':
+        case 'mail':
+        case 'omb':
+        case 'api':
+            $this->element('span', 'device', $source_name);
+            break;
+        default:
+            $ns = Notice_source::staticGet($source);
+            if ($ns) {
+                $this->elementStart('span', 'device');
+                $this->element('a', array('href' => $ns->url,
+                                               'rel' => 'external'),
+                                    $ns->name);
+                $this->elementEnd('span');
+            } else {
+                $this->out->element('span', 'device', $source_name);
+            }
+            break;
         }
+        return;
+    }
 
-        common_element_end('p');
+    /**
+     * Mailbox actions are read only
+     *
+     * @param array $args other arguments
+     *
+     * @return boolean
+     */
 
-        common_element_end('li');
+    function isReadOnly($args)
+    {
+         return true;
     }
+
 }