plugins/Bookmark/newbookmark.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2010, StatusNet, Inc.
   5  *
   6  * Add a new bookmark
   7  *
   8  * PHP version 5
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @category  Bookmark
  24  * @package   StatusNet
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @copyright 2010 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  28  * @link      http://status.net/
  29  */
  30 if (!defined('STATUSNET')) {
  31     // This check helps protect against security problems;
  32     // your code file can't be executed directly from the web.
  33     exit(1);
  34 }
  35
  36 /**
  37  * Add a new bookmark
  38  *
  39  * @category  Bookmark
  40  * @package   StatusNet
  41  * @author    Evan Prodromou <evan@status.net>
  42  * @copyright 2010 StatusNet, Inc.
  43  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  44  * @link      http://status.net/
  45  */
  46
  47 class NewbookmarkAction extends Action
  48 {
  49     protected $user        = null;
  50     protected $error       = null;
  51     protected $complete    = null;
  52     protected $title       = null;
  53     protected $url         = null;
  54     protected $tags        = null;
  55     protected $description = null;
  56
  57     /**
  58      * Returns the title of the action
  59      *
  60      * @return string Action title
  61      */
  62
  63     function title()
  64     {
  65         return _('New bookmark');
  66     }
  67
  68     /**
  69      * For initializing members of the class.
  70      *
  71      * @param array $argarray misc. arguments
  72      *
  73      * @return boolean true
  74      */
  75
  76     function prepare($argarray)
  77     {
  78         parent::prepare($argarray);
  79
  80         $this->user = common_current_user();
  81
  82         if (empty($this->user)) {
  83             throw new ClientException(_("Must be logged in to post a bookmark."),
  84                                       403);
  85         }
  86
  87         if ($this->isPost()) {
  88             $this->checkSessionToken();
  89         }
  90
  91         $this->title       = $this->trimmed('title');
  92         $this->url         = $this->trimmed('url');
  93         $this->tags        = $this->trimmed('tags');
  94         $this->description = $this->trimmed('description');
  95
  96         return true;
  97     }
  98
  99     /**
 100      * Handler method
 101      *
 102      * @param array $argarray is ignored since it's now passed in in prepare()
 103      *
 104      * @return void
 105      */
 106
 107     function handle($argarray=null)
 108     {
 109         parent::handle($argarray);
 110
 111         if ($this->isPost()) {
 112             $this->newBookmark();
 113         } else {
 114             $this->showPage();
 115         }
 116
 117         return;
 118     }
 119
 120     /**
 121      * Add a new bookmark
 122      *
 123      * @return void
 124      */
 125
 126     function newBookmark()
 127     {
 128         if ($this->boolean('ajax')) {
 129             StatusNet::setApi(true);
 130         }
 131         try {
 132             if (empty($this->title)) {
 133                 throw new ClientException(_('Bookmark must have a title.'));
 134             }
 135
 136             if (empty($this->url)) {
 137                 throw new ClientException(_('Bookmark must have an URL.'));
 138             }
 139
 140
 141             $saved = Bookmark::saveNew($this->user->getProfile(),
 142                                               $this->title,
 143                                               $this->url,
 144                                               $this->tags,
 145                                               $this->description);
 146
 147         } catch (ClientException $ce) {
 148             $this->error = $ce->getMessage();
 149             $this->showPage();
 150             return;
 151         }
 152
 153         if ($this->boolean('ajax')) {
 154             header('Content-Type: text/xml;charset=utf-8');
 155             $this->xw->startDocument('1.0', 'UTF-8');
 156             $this->elementStart('html');
 157             $this->elementStart('head');
 158             // TRANS: Page title after sending a notice.
 159             $this->element('title', null, _('Notice posted'));
 160             $this->elementEnd('head');
 161             $this->elementStart('body');
 162             $this->showNotice($saved);
 163             $this->elementEnd('body');
 164             $this->elementEnd('html');
 165         } else {
 166             common_redirect($saved->bestUrl(), 303);
 167         }
 168     }
 169
 170     /**
 171      * Output a notice
 172      *
 173      * Used to generate the notice code for Ajax results.
 174      *
 175      * @param Notice $notice Notice that was saved
 176      *
 177      * @return void
 178      */
 179     function showNotice($notice)
 180     {
 181         class_exists('NoticeList'); // @fixme hack for autoloader
 182         $nli = new NoticeListItem($notice, $this);
 183         $nli->show();
 184     }
 185
 186     /**
 187      * Show the bookmark form
 188      *
 189      * @return void
 190      */
 191
 192     function showContent()
 193     {
 194         if (!empty($this->error)) {
 195             $this->element('p', 'error', $this->error);
 196         }
 197
 198         $form = new BookmarkForm($this,
 199                                  $this->title,
 200                                  $this->url,
 201                                  $this->tags,
 202                                  $this->description);
 203
 204         $form->show();
 205
 206         return;
 207     }
 208
 209     /**
 210      * Return true if read only.
 211      *
 212      * MAY override
 213      *
 214      * @param array $args other arguments
 215      *
 216      * @return boolean is read only action?
 217      */
 218
 219     function isReadOnly($args)
 220     {
 221         if ($_SERVER['REQUEST_METHOD'] == 'GET' ||
 222             $_SERVER['REQUEST_METHOD'] == 'HEAD') {
 223             return true;
 224         } else {
 225             return false;
 226         }
 227     }
 228 }
 229