plugins/Blog/BlogPlugin.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2011, StatusNet, Inc.
   5  *
   6  * A microapp to implement lite blogging
   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  Blog
  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  * Blog plugin
  39  *
  40  * Many social systems have a way to write and share long-form texts with
  41  * your network. This microapp plugin lets users post blog entries.
  42  *
  43  * @category  Blog
  44  * @package   StatusNet
  45  * @author    Evan Prodromou <evan@status.net>
  46  * @copyright 2011 StatusNet, Inc.
  47  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  48  * @link      http://status.net/
  49  */
  50
  51 class BlogPlugin extends MicroAppPlugin
  52 {
  53
  54     var $oldSaveNew = true;
  55
  56     /**
  57      * Database schema setup
  58      *
  59      * @see Schema
  60      * @see ColumnDef
  61      *
  62      * @return boolean hook value; true means continue processing, false means stop.
  63      */
  64     function onCheckSchema()
  65     {
  66         $schema = Schema::get();
  67
  68         $schema->ensureTable('blog_entry', Blog_entry::schemaDef());
  69
  70         return true;
  71     }
  72
  73     /**
  74      * Map URLs to actions
  75      *
  76      * @param Net_URL_Mapper $m path-to-action mapper
  77      *
  78      * @return boolean hook value; true means continue processing, false means stop.
  79      */
  80     function onRouterInitialized($m)
  81     {
  82         $m->connect('blog/new',
  83                     array('action' => 'newblogentry'));
  84         $m->connect('blog/:id',
  85                     array('action' => 'showblogentry'),
  86                     array('id' => UUID::REGEX));
  87         return true;
  88     }
  89
  90     function onPluginVersion(array &$versions)
  91     {
  92         $versions[] = array('name' => 'Blog',
  93                             'version' => GNUSOCIAL_VERSION,
  94                             'author' => 'Evan Prodromou',
  95                             'homepage' => 'http://status.net/wiki/Plugin:Blog',
  96                             'rawdescription' =>
  97                             // TRANS: Plugin description.
  98                             _m('Let users write and share long-form texts.'));
  99         return true;
 100     }
 101
 102     function appTitle()
 103     {
 104         // TRANS: Blog application title.
 105         return _m('TITLE','Blog');
 106     }
 107
 108     function tag()
 109     {
 110         return 'blogentry';
 111     }
 112
 113     function types()
 114     {
 115         return array(Blog_entry::TYPE);
 116     }
 117
 118     function saveNoticeFromActivity(Activity $activity, Profile $actor, array $options=array())
 119     {
 120         if (count($activity->objects) != 1) {
 121             // TRANS: Exception thrown when there are too many activity objects.
 122             throw new ClientException(_m('Too many activity objects.'));
 123         }
 124
 125         $entryObj = $activity->objects[0];
 126
 127         if ($entryObj->type != Blog_entry::TYPE) {
 128             // TRANS: Exception thrown when blog plugin comes across a non-blog entry type object.
 129             throw new ClientException(_m('Wrong type for object.'));
 130         }
 131
 132         $notice = null;
 133
 134         switch ($activity->verb) {
 135         case ActivityVerb::POST:
 136             $notice = Blog_entry::saveNew($actor,
 137                                          $entryObj->title,
 138                                          $entryObj->content,
 139                                          $options);
 140             break;
 141         default:
 142             // TRANS: Exception thrown when blog plugin comes across a undefined verb.
 143             throw new ClientException(_m('Unknown verb for blog entries.'));
 144         }
 145
 146         return $notice;
 147     }
 148
 149     function activityObjectFromNotice(Notice $notice)
 150     {
 151         $entry = Blog_entry::fromNotice($notice);
 152
 153         if (empty($entry)) {
 154             // TRANS: Exception thrown when requesting a non-existing blog entry for notice.
 155             throw new ClientException(sprintf(_m('No blog entry for notice %s.'),
 156                         $notice->id));
 157         }
 158
 159         return $entry->asActivityObject();
 160     }
 161
 162     function entryForm($out)
 163     {
 164         return new BlogEntryForm($out);
 165     }
 166
 167     function deleteRelated(Notice $notice)
 168     {
 169         if ($notice->object_type == Blog_entry::TYPE) {
 170             $entry = Blog_entry::fromNotice($notice);
 171             if (!empty($entry)) {
 172                 $entry->delete();
 173             }
 174         }
 175     }
 176
 177     function adaptNoticeListItem($nli)
 178     {
 179         $notice = $nli->notice;
 180
 181         if ($notice->object_type == Blog_entry::TYPE) {
 182             return new BlogEntryListItem($nli);
 183         }
 184
 185         return null;
 186     }
 187
 188     function onEndShowScripts($action)
 189     {
 190         $action->script(common_path('plugins/TinyMCE/js/jquery.tinymce.js'));
 191         $action->inlineScript('var _tinymce_path = "'.common_path('plugins/TinyMCE/js/tiny_mce.js').'";'."\n".
 192                               'var _tinymce_placeholder = "'.common_path('plugins/TinyMCE/icons/placeholder.png').'";'."\n");
 193         $action->script($this->path('blog.js'));
 194         return true;
 195     }
 196 }