plugins/Bookmark/actions/bookmarkforurl.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2011, StatusNet, Inc.
   5  *
   6  * Returns a pre-filled bookmark form for a given URL
   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 2011 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     // This check helps protect against security problems;
  33     // your code file can't be executed directly from the web.
  34     exit(1);
  35 }
  36
  37 /**
  38  * Returns a prefilled bookmark form for a given URL
  39  *
  40  * @category  Bookmark
  41  * @package   StatusNet
  42  * @author    Evan Prodromou <evan@status.net>
  43  * @copyright 2011 StatusNet, Inc.
  44  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  45  * @link      http://status.net/
  46  */
  47
  48 class BookmarkforurlAction extends Action
  49 {
  50     protected $url        = null;
  51     protected $oembed     = null;
  52     protected $thumbnail  = null;
  53     protected $title      = null;
  54
  55     /**
  56      * For initializing members of the class.
  57      *
  58      * @param array $args misc. arguments
  59      *
  60      * @return boolean true
  61      */
  62     function prepare(array $args=array())
  63     {
  64         parent::prepare($args);
  65
  66         if (!$this->isPost()) {
  67             throw new ClientException(_('POST only'), 405);
  68         }
  69
  70         $this->checkSessionToken();
  71         $this->url = $this->trimmed('url');
  72
  73         if (empty($this->url)) {
  74             throw new ClientException(_('URL is required.'), 400);
  75         }
  76
  77         if (!common_valid_http_url($this->url)) {
  78             throw new ClientException(_('Invalid URL.'), 400);
  79         }
  80
  81         try {
  82             // processNew will first try to fetch a locally stored File entry
  83             $f = File::processNew($this->url);
  84         } catch (ServerException $e) {
  85             $f = null;
  86         }
  87
  88         // How about now?
  89
  90         if ($f instanceof File) {
  91             // FIXME: Use some File metadata Event instead
  92             $this->oembed    = File_oembed::getKV('file_id', $f->id);
  93             if ($this->oembed instanceof File_oembed) {
  94                 $this->title = $this->oembed->title;
  95             }
  96             $this->thumbnail = File_thumbnail::getKV('file_id', $f->id);
  97         }
  98
  99         return true;
 100     }
 101
 102     /**
 103      * Handler method
 104      *
 105      * @param array $args is ignored since it's now passed in in prepare()
 106      * @return void
 107      */
 108     function handle(array $args=array())
 109     {
 110         $this->startHTML('text/xml;charset=utf-8');
 111         $this->elementStart('head');
 112         $this->element('title', null, _('Bookmark form'));
 113         $this->elementEnd('head');
 114         $this->elementStart('body');
 115         $bf = new BookmarkForm($this, $this->title, $this->url, null, null, $this->thumbnail);
 116         $bf->show();
 117         $this->elementEnd('body');
 118         $this->endHTML();
 119     }
 120
 121     /**
 122      * Return true if read only.
 123      *
 124      * MAY override
 125      *
 126      * @param array $args other arguments
 127      * @return boolean is read only action?
 128      */
 129     function isReadOnly(array $args=array())
 130     {
 131         return false;
 132     }
 133 }