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
|
<?php
/**
* Provides the ECML service to plugins.
*
* @package ECML
* @license http://www.gnu.org/licenses/old-licenses/gpl-2.0.html GNU Public License version 2
* @author Curverider Ltd
* @copyright Curverider Ltd 2008-2010
* @link http://elgg.org/
*
* @todo
* Granular access to keywords based upon view.
* Update docs / help
* Check for SQL injection problems.
* Check entity keyword views against fullview. Force to FALSE?
*/
/**
* Init ECML
*/
function ecml_init() {
require_once(dirname(__FILE__) . '/ecml_functions.php');
global $CONFIG;
define('ECML_ATTR_SEPARATOR', ' ');
define('ECML_ATTR_OPERATOR', '=');
// help page
register_page_handler('ecml', 'ecml_help_page_handler');
// admin access page
register_page_handler('ecml_admin', 'ecml_admin_page_handler');
register_elgg_event_handler('pagesetup', 'system', 'ecml_pagesetup');
// CSS for admin access
elgg_extend_view('css', 'ecml/admin/css');
// admin action to save permissions
register_action('ecml/save_permissions', FALSE, dirname(__FILE__) . '/actions/save_permissions.php', TRUE);
// show ECML-enabled icon on free-text input areas
elgg_extend_view('input/longtext', 'ecml/input_ext');
elgg_extend_view('input/plaintext', 'ecml/input_ext');
//elgg_extend_view('input/text', 'ecml/input_ext');
// add parsing for core views.
register_plugin_hook('get_views', 'ecml', 'ecml_views_hook');
// get register the views we want to parse for ecml
// @todo will need to do profiling to see if it would be faster
// to foreach through this list and register to specific views or
// do the check in a single plugin hook.
// Wants array('view_name' => 'Short Description')
$CONFIG->ecml_parse_views = trigger_plugin_hook('get_views', 'ecml', NULL, array());
foreach ($CONFIG->ecml_parse_views as $view => $desc) {
register_plugin_hook('view', $view, 'ecml_parse_view');
}
// provide a few built-in ecml keywords.
// @todo could pull this out into an array here to save an API call.
register_plugin_hook('get_keywords', 'ecml', 'ecml_keyword_hook');
// grab the list of keywords and their views from plugins
$CONFIG->ecml_keywords = trigger_plugin_hook('get_keywords', 'ecml', NULL, array());
// grab permissions for specific views/contexts
// this is a black list.
// it's more efficient to use this as a blacklist
// but probably makes more sense from a UI perspective as a whitelist.
// uses [views][view_name] = array(keywords, not, allowed)
$CONFIG->ecml_permissions = unserialize(get_plugin_setting('ecml_permissions', 'ecml'));
}
/**
* Page setup. Adds admin controls to the admin panel for granular permission
*/
function ecml_pagesetup(){
if (get_context() == 'admin' && isadminloggedin()) {
global $CONFIG;
add_submenu_item(elgg_echo('ecml'), $CONFIG->wwwroot . 'pg/ecml_admin');
}
}
/**
* Display a help page for valid ECML keywords on this page.
*
* @param array $page
*/
function ecml_help_page_handler($page) {
$content = elgg_view('ecml/help');
echo page_draw(elgg_echo('ecml:help'), $content);
}
/**
* Display a help page for valid ECML keywords on this page.
*
* @param array $page
*/
function ecml_admin_page_handler($page) {
admin_gatekeeper();
$content = elgg_view('ecml/admin/ecml_admin');
echo page_draw(elgg_echo('ecml:admin'), $content);
}
/**
* Parses a registered view / context for supported keywords.
*
* @param unknown_type $hook
* @param unknown_type $entity_type
* @param unknown_type $return_value
* @param unknown_type $params
* @return string
*/
function ecml_parse_view($hook, $entity_type, $return_value, $params) {
global $CONFIG;
// give me everything that is not a ], possibly followed by a :, and surrounded by [[ ]]s
//$keyword_regex = '/\[\[([a-z0-9_]+):?([^\]]+)?\]\]/';
$keyword_regex = '/\[\[([a-z0-9]+)([^\]]+)?\]\]/';
$CONFIG->ecml_current_view = $params['view'];
$return_value = preg_replace_callback($keyword_regex, 'ecml_parse_view_match', $return_value);
return $return_value;
}
/**
* Register default keywords.
*
* @param unknown_type $hook
* @param unknown_type $type
* @param unknown_type $value
* @param unknown_type $params
* @return unknown_type
*/
function ecml_keyword_hook($hook, $type, $value, $params) {
// I keep going back and forth about entity and view. They're powerful, but
// a great way to let a site get hacked if the admin doesn't lock them down.
$keywords = array('entity', 'view', 'youtube', 'slideshare', 'vimeo', 'googlemaps');
foreach ($keywords as $keyword) {
$value[$keyword] = array(
'view' => "ecml/keywords/$keyword",
'description' => elgg_echo("ecml:keywords:desc:$keyword"),
'usage' => elgg_echo("ecml:keywords:usage:$keyword")
);
}
return $value;
}
/**
* Register default views to parse
*
* @param unknown_type $hook
* @param unknown_type $type
* @param unknown_type $value
* @param unknown_type $params
*/
function ecml_views_hook($hook, $type, $value, $params) {
$value['annotation/generic_comment'] = elgg_echo('ecml:views:annotation_generic_comment');
return $value;
}
register_elgg_event_handler('init', 'system', 'ecml_init');
|
