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      * Database schema setup
  55      *
  56      * @see Schema
  57      * @see ColumnDef
  58      *
  59      * @return boolean hook value; true means continue processing, false means stop.
  60      */
  61     function onCheckSchema()
  62     {
  63         $schema = Schema::get();
  64
  65         $schema->ensureTable('blog_entry', Blog_entry::schemaDef());
  66
  67         return true;
  68     }
  69
  70     /**
  71      * Load related modules when needed
  72      *
  73      * @param string $cls Name of the class to be loaded
  74      *
  75      * @return boolean hook value; true means continue processing, false means stop.
  76      */
  77     function onAutoload($cls)
  78     {
  79         $dir = dirname(__FILE__);
  80
  81         switch ($cls)
  82         {
  83         case 'NewblogentryAction':
  84         case 'ShowblogentryAction':
  85             include_once $dir . '/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
  86             return false;
  87         case 'BlogEntryForm':
  88         case 'BlogEntryListItem':
  89             include_once $dir . '/'.strtolower($cls).'.php';
  90             return false;
  91         case 'Blog_entry':
  92             include_once $dir . '/'.$cls.'.php';
  93             return false;
  94         default:
  95             return true;
  96         }
  97     }
  98
  99     /**
 100      * Map URLs to actions
 101      *
 102      * @param Net_URL_Mapper $m path-to-action mapper
 103      *
 104      * @return boolean hook value; true means continue processing, false means stop.
 105      */
 106     function onRouterInitialized($m)
 107     {
 108         $m->connect('blog/new',
 109                     array('action' => 'newblogentry'));
 110         $m->connect('blog/:id',
 111                     array('action' => 'showblogentry'),
 112                     array('id' => UUID::REGEX));
 113         return true;
 114     }
 115
 116     function onPluginVersion(&$versions)
 117     {
 118         $versions[] = array('name' => 'Blog',
 119                             'version' => STATUSNET_VERSION,
 120                             'author' => 'Evan Prodromou',
 121                             'homepage' => 'http://status.net/wiki/Plugin:Blog',
 122                             'rawdescription' =>
 123                             _m('Let users write and share long-form texts.'));
 124         return true;
 125     }
 126
 127     function appTitle()
 128     {
 129         return _m('Blog');
 130     }
 131
 132     function tag()
 133     {
 134         return 'blog';
 135     }
 136
 137     function types()
 138     {
 139         return array(Blog_entry::TYPE);
 140     }
 141
 142     function saveNoticeFromActivity($activity, $actor, $options=array())
 143     {
 144         if (count($activity->objects) != 1) {
 145             // TRANS: Exception thrown when there are too many activity objects.
 146             throw new ClientException(_m('Too many activity objects.'));
 147         }
 148
 149         $entryObj = $activity->objects[0];
 150
 151         if ($entryObj->type != Blog_entry::TYPE) {
 152             // TRANS: Exception thrown when blog plugin comes across a non-event type object.
 153             throw new ClientException(_m('Wrong type for object.'));
 154         }
 155
 156         $notice = null;
 157
 158         switch ($activity->verb) {
 159         case ActivityVerb::POST:
 160             $notice = Blog_entry::saveNew($actor,
 161                                          $entryObj->title,
 162                                          $entryObj->content,
 163                                          $options);
 164             break;
 165         default:
 166             // TRANS: Exception thrown when blog plugin comes across a undefined verb.
 167             throw new ClientException(_m('Unknown verb for blog entries.'));
 168         }
 169
 170         return $notice;
 171     }
 172
 173     function activityObjectFromNotice($notice)
 174     {
 175         $entry = Blog_entry::fromNotice($notice);
 176
 177         if (empty($entry)) {
 178             throw new ClientException(sprintf(_('No blog entry for notice %s'),
 179                         $notice->id));
 180         }
 181
 182         return $entry->asActivityObject();
 183     }
 184
 185     function entryForm($out)
 186     {
 187         return new BlogEntryForm($out);
 188     }
 189
 190     function deleteRelated($notice)
 191     {
 192         if ($notice->object_type == Blog_entry::TYPE) {
 193             $entry = Blog_entry::fromNotice($notice);
 194             if (exists($entry)) {
 195                 $entry->delete();
 196             }
 197         }
 198     }
 199
 200     function adaptNoticeListItem($nli)
 201     {
 202         $notice = $nli->notice;
 203
 204         if ($notice->object_type == Blog_entry::TYPE) {
 205             return new BlogEntryListItem($nli);
 206         }
 207
 208         return null;
 209     }
 210 }