1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
|
<?php
/**
* Elgg Bookmarks plugin
*
* @package ElggBookmarks
*/
elgg_register_event_handler('init', 'system', 'bookmarks_init');
/**
* Bookmark init
*/
function bookmarks_init() {
$root = dirname(__FILE__);
elgg_register_library('elgg:bookmarks', "$root/lib/bookmarks.php");
// actions
$action_path = "$root/actions/bookmarks";
elgg_register_action('bookmarks/save', "$action_path/save.php");
elgg_register_action('bookmarks/delete', "$action_path/delete.php");
elgg_register_action('bookmarks/share', "$action_path/share.php");
// menus
elgg_register_menu_item('site', array(
'name' => 'bookmarks',
'text' => elgg_echo('bookmarks'),
'href' => 'bookmarks/all'
));
elgg_register_plugin_hook_handler('register', 'menu:page', 'bookmarks_page_menu');
elgg_register_plugin_hook_handler('register', 'menu:owner_block', 'bookmarks_owner_block_menu');
elgg_register_page_handler('bookmarks', 'bookmarks_page_handler');
elgg_extend_view('css/elgg', 'bookmarks/css');
elgg_extend_view('js/elgg', 'bookmarks/js');
elgg_register_widget_type('bookmarks', elgg_echo('bookmarks'), elgg_echo('bookmarks:widget:description'));
if (elgg_is_logged_in()) {
$user_guid = elgg_get_logged_in_user_guid();
$address = urlencode(current_page_url());
elgg_register_menu_item('extras', array(
'name' => 'bookmark',
'text' => elgg_view_icon('push-pin-alt'),
'href' => "bookmarks/add/$user_guid?address=$address",
'title' => elgg_echo('bookmarks:this'),
'rel' => 'nofollow',
));
}
// Register granular notification for this type
register_notification_object('object', 'bookmarks', elgg_echo('bookmarks:new'));
// Listen to notification events and supply a more useful message
elgg_register_plugin_hook_handler('notify:entity:message', 'object', 'bookmarks_notify_message');
// Register a URL handler for bookmarks
elgg_register_entity_url_handler('object', 'bookmarks', 'bookmark_url');
// Register entity type for search
elgg_register_entity_type('object', 'bookmarks');
// Groups
add_group_tool_option('bookmarks', elgg_echo('bookmarks:enablebookmarks'), true);
elgg_extend_view('groups/tool_latest', 'bookmarks/group_module');
}
/**
* Dispatcher for bookmarks.
*
* URLs take the form of
* All bookmarks: bookmarks/all
* User's bookmarks: bookmarks/owner/<username>
* Friends' bookmarks: bookmarks/friends/<username>
* View bookmark: bookmarks/view/<guid>/<title>
* New bookmark: bookmarks/add/<guid> (container: user, group, parent)
* Edit bookmark: bookmarks/edit/<guid>
* Group bookmarks: bookmarks/group/<guid>/all
* Bookmarklet: bookmarks/bookmarklet/<guid> (user)
*
* Title is ignored
*
* @param array $page
*/
function bookmarks_page_handler($page) {
elgg_load_library('elgg:bookmarks');
elgg_push_breadcrumb(elgg_echo('bookmarks'), 'bookmarks/all');
elgg_push_context('bookmarks');
// old group usernames
if (substr_count($page[0], 'group:')) {
preg_match('/group\:([0-9]+)/i', $page[0], $matches);
$guid = $matches[1];
if ($entity = get_entity($guid)) {
bookmarks_url_forwarder($page);
}
}
// user usernames
$user = get_user_by_username($page[0]);
if ($user) {
bookmarks_url_forwarder($page);
}
$pages = dirname(__FILE__) . '/pages/bookmarks';
switch ($page[0]) {
case "all":
include "$pages/all.php";
break;
case "owner":
include "$pages/owner.php";
break;
case "friends":
include "$pages/friends.php";
break;
case "read":
case "view":
set_input('guid', $page[1]);
include "$pages/view.php";
break;
case "add":
gatekeeper();
include "$pages/add.php";
break;
case "edit":
gatekeeper();
set_input('guid', $page[1]);
include "$pages/edit.php";
break;
case 'group':
group_gatekeeper();
include "$pages/owner.php";
break;
case "bookmarklet":
set_input('container_guid', $page[1]);
include "$pages/bookmarklet.php";
break;
default:
return false;
}
elgg_pop_context();
return true;
}
/**
* Forward to the new style of URLs
*
* @param string $page
*/
function bookmarks_url_forwarder($page) {
global $CONFIG;
if (!isset($page[1])) {
$page[1] = 'items';
}
switch ($page[1]) {
case "read":
$url = "{$CONFIG->wwwroot}bookmarks/view/{$page[2]}/{$page[3]}";
break;
case "inbox":
$url = "{$CONFIG->wwwroot}bookmarks/inbox/{$page[0]}";
break;
case "friends":
$url = "{$CONFIG->wwwroot}bookmarks/friends/{$page[0]}";
break;
case "add":
$url = "{$CONFIG->wwwroot}bookmarks/add/{$page[0]}";
break;
case "items":
$url = "{$CONFIG->wwwroot}bookmarks/owner/{$page[0]}";
break;
case "bookmarklet":
$url = "{$CONFIG->wwwroot}bookmarks/bookmarklet/{$page[0]}";
break;
}
register_error(elgg_echo("changebookmark"));
forward($url);
}
/**
* Populates the ->getUrl() method for bookmarked objects
*
* @param ElggEntity $entity The bookmarked object
* @return string bookmarked item URL
*/
function bookmark_url($entity) {
global $CONFIG;
$title = $entity->title;
$title = elgg_get_friendly_title($title);
return $CONFIG->url . "bookmarks/view/" . $entity->getGUID() . "/" . $title;
}
/**
* Add a menu item to an ownerblock
*
* @param string $hook
* @param string $type
* @param array $return
* @param array $params
*/
function bookmarks_owner_block_menu($hook, $type, $return, $params) {
if (elgg_instanceof($params['entity'], 'user')) {
$url = "bookmarks/owner/{$params['entity']->username}";
$item = new ElggMenuItem('bookmarks', elgg_echo('bookmarks'), $url);
$return[] = $item;
} else {
if ($params['entity']->bookmarks_enable != 'no') {
$url = "bookmarks/group/{$params['entity']->guid}/all";
$item = new ElggMenuItem('bookmarks', elgg_echo('bookmarks:group'), $url);
$return[] = $item;
}
}
return $return;
}
/**
* Returns the body of a notification message
*
* @param string $hook
* @param string $entity_type
* @param string $returnvalue
* @param array $params
*/
function bookmarks_notify_message($hook, $entity_type, $returnvalue, $params) {
$entity = $params['entity'];
$to_entity = $params['to_entity'];
$method = $params['method'];
if (($entity instanceof ElggEntity) && ($entity->getSubtype() == 'bookmarks')) {
$descr = $entity->description;
$title = $entity->title;
global $CONFIG;
$url = elgg_get_site_url() . "view/" . $entity->guid;
if ($method == 'sms') {
$owner = $entity->getOwnerEntity();
return $owner->name . ' ' . elgg_echo("bookmarks:via") . ': ' . $url . ' (' . $title . ')';
}
if ($method == 'email') {
$owner = $entity->getOwnerEntity();
return $owner->name . ' ' . elgg_echo("bookmarks:via") . ': ' . $title . "\n\n" . $descr . "\n\n" . $entity->getURL();
}
if ($method == 'web') {
$owner = $entity->getOwnerEntity();
return $owner->name . ' ' . elgg_echo("bookmarks:via") . ': ' . $title . "\n\n" . $descr . "\n\n" . $entity->getURL();
}
}
return null;
}
/**
* Add a page menu menu.
*
* @param string $hook
* @param string $type
* @param array $return
* @param array $params
*/
function bookmarks_page_menu($hook, $type, $return, $params) {
if (elgg_is_logged_in()) {
// only show bookmarklet in bookmark pages
if (elgg_in_context('bookmarks')) {
$page_owner = elgg_get_page_owner_entity();
if (!$page_owner) {
$page_owner = elgg_get_logged_in_user_entity();
}
if ($page_owner instanceof ElggGroup) {
$title = elgg_echo('bookmarks:bookmarklet:group');
} else {
$title = elgg_echo('bookmarks:bookmarklet');
}
$return[] = new ElggMenuItem('bookmarklet', $title, 'bookmarks/bookmarklet/' . $page_owner->getGUID());
}
}
return $return;
}
|
