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
/**
* Helper functions for ECML.
*
* @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/
*/
/**
* Parse ECML keywords
*
* @param array $matches
* @return string html
*/
function ecml_parse_view_match($matches) {
global $CONFIG;
$view = $CONFIG->ecml_current_view;
$keyword = trim($matches[1]);
$params_string = trim($matches[2]);
// reject keyword if blacklisted for view or invalid
if (!ecml_is_valid_keyword($keyword, $view)) {
return $matches[0];
}
switch ($keyword) {
case 'entity':
$options = ecml_keywords_parse_entity_params($params_string);
// must use this lower-level function because I missed refactoring
// the list entity functions for relationships.
// (which, since you're here, is the only function that runs through all
// possible options for elgg_get_entities*() functions...)
$entities = elgg_get_entities_from_relationship($options);
$content = elgg_view_entity_list($entities, count($entities), $options['offset'],
$options['limit'], $options['full_view'], $options['view_type_toggle'], $options['pagination']);
break;
case 'view':
// parses this into an acceptable array for $vars.
$info = ecml_keywords_parse_view_params($params_string);
$content = elgg_view($info['view'], $info['vars']);
break;
default:
// match against custom keywords with optional args
$keyword_info = $CONFIG->ecml_keywords[$keyword];
$vars = ecml_keywords_tokenize_params($params_string);
$content = elgg_view($keyword_info['view'], $vars);
break;
}
// if nothing matched return the original string.
if (!$content) {
$content = $matches[0];
}
return $content;
}
/**
* Creates an array from a "name=value, name2=value2" string.
*
* @param $string
* @return array
*/
function ecml_keywords_tokenize_params($string) {
$pairs = array_map('trim', explode(',', $string));
$params = array();
foreach ($pairs as $pair) {
list($name, $value) = explode('=', $pair);
$name = trim($name);
$value = trim($value);
// normalize BOOL values
if ($value === 'true') {
$value = TRUE;
} elseif ($value === 'false') {
$value = FALSE;
}
// don't check against value since a falsy/empty value is valid.
if ($name) {
$params[$name] = $value;
}
}
return $params;
}
/**
* Extract the view and vars for view: keyword
*
* @param $string
* @return array views, vars
*/
function ecml_keywords_parse_view_params($string) {
$vars = ecml_keywords_tokenize_params($string);
// the first element key is the view
$var_keys = array_keys($vars);
$view = $var_keys[0];
$info = array(
'view' => $view,
'vars' => $vars
);
return $info;
}
/**
* Returns an options array suitable for using in elgg_get_entities()
*
* @param string $string "name=value, name2=value2"
* @return array
*/
function ecml_keywords_parse_entity_params($string) {
$params = ecml_keywords_tokenize_params($string);
// handle some special cases
if (isset($params['owner'])) {
if ($user = get_user_by_username($params['owner'])) {
$params['owner_guid'] = $user->getGUID();
}
}
// @todo probably need to add more for
// group -> container_guid, etc
return $params;
}
/**
* Checks granular permissions if keyword is valid for view
*
* @param unknown_type $keyword
* @param unknown_type $view
* @return bool
*/
function ecml_is_valid_keyword($keyword, $view = NULL) {
global $CONFIG;
// this isn't even a real keyword.
if (!isset($CONFIG->ecml_keywords[$keyword])) {
return FALSE;
}
$views = $CONFIG->ecml_permissions['views'];
$contexts = $CONFIG->ecml_permissions['contexts'];
// this is a blacklist, so return TRUE by default.
$r = TRUE;
if (isset($views[$view]) && in_array($keyword, $views[$view])) {
$r = FALSE;
}
return $r;
}
|
