]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - plugins/Blog/BlogPlugin.php
Only run EndSubscribe when it is really a sub
[quix0rs-gnu-social.git] / 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      * Map URLs to actions
72      *
73      * @param Net_URL_Mapper $m path-to-action mapper
74      *
75      * @return boolean hook value; true means continue processing, false means stop.
76      */
77     function onRouterInitialized($m)
78     {
79         $m->connect('blog/new',
80                     array('action' => 'newblogentry'));
81         $m->connect('blog/:id',
82                     array('action' => 'showblogentry'),
83                     array('id' => UUID::REGEX));
84         return true;
85     }
86
87     function onPluginVersion(&$versions)
88     {
89         $versions[] = array('name' => 'Blog',
90                             'version' => GNUSOCIAL_VERSION,
91                             'author' => 'Evan Prodromou',
92                             'homepage' => 'http://status.net/wiki/Plugin:Blog',
93                             'rawdescription' =>
94                             // TRANS: Plugin description.
95                             _m('Let users write and share long-form texts.'));
96         return true;
97     }
98
99     function appTitle()
100     {
101         // TRANS: Blog application title.
102         return _m('TITLE','Blog');
103     }
104
105     function tag()
106     {
107         return 'blog';
108     }
109
110     function types()
111     {
112         return array(Blog_entry::TYPE);
113     }
114
115     function saveNoticeFromActivity($activity, $actor, $options=array())
116     {
117         if (count($activity->objects) != 1) {
118             // TRANS: Exception thrown when there are too many activity objects.
119             throw new ClientException(_m('Too many activity objects.'));
120         }
121
122         $entryObj = $activity->objects[0];
123
124         if ($entryObj->type != Blog_entry::TYPE) {
125             // TRANS: Exception thrown when blog plugin comes across a non-blog entry type object.
126             throw new ClientException(_m('Wrong type for object.'));
127         }
128
129         $notice = null;
130
131         switch ($activity->verb) {
132         case ActivityVerb::POST:
133             $notice = Blog_entry::saveNew($actor,
134                                          $entryObj->title,
135                                          $entryObj->content,
136                                          $options);
137             break;
138         default:
139             // TRANS: Exception thrown when blog plugin comes across a undefined verb.
140             throw new ClientException(_m('Unknown verb for blog entries.'));
141         }
142
143         return $notice;
144     }
145
146     function activityObjectFromNotice($notice)
147     {
148         $entry = Blog_entry::fromNotice($notice);
149
150         if (empty($entry)) {
151             // TRANS: Exception thrown when requesting a non-existing blog entry for notice.
152             throw new ClientException(sprintf(_m('No blog entry for notice %s.'),
153                         $notice->id));
154         }
155
156         return $entry->asActivityObject();
157     }
158
159     function entryForm($out)
160     {
161         return new BlogEntryForm($out);
162     }
163
164     function deleteRelated($notice)
165     {
166         if ($notice->object_type == Blog_entry::TYPE) {
167             $entry = Blog_entry::fromNotice($notice);
168             if (!empty($entry)) {
169                 $entry->delete();
170             }
171         }
172     }
173
174     function adaptNoticeListItem($nli)
175     {
176         $notice = $nli->notice;
177
178         if ($notice->object_type == Blog_entry::TYPE) {
179             return new BlogEntryListItem($nli);
180         }
181
182         return null;
183     }
184
185     function onEndShowScripts($action)
186     {
187         $action->script(common_path('plugins/TinyMCE/js/jquery.tinymce.js'));
188         $action->inlineScript('var _tinymce_path = "'.common_path('plugins/TinyMCE/js/tiny_mce.js').'";'."\n".
189                               'var _tinymce_placeholder = "'.common_path('plugins/TinyMCE/icons/placeholder.png').'";'."\n");
190         $action->script($this->path('blog.js'));
191         return true;
192     }
193 }