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
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
|
<?php
/**
* Elgg calendar / entity / event functions.
*
* @package Elgg
* @subpackage Core
* @license http://www.gnu.org/licenses/old-licenses/gpl-2.0.html GNU Public License version 2
* @author Curverider Ltd
* @copyright Curverider Ltd 2008
* @link http://elgg.org/
*/
/**
* Calendar interface for events.
*
*/
interface Noteable {
/**
* Calendar functionality.
* This function sets the time of an object on a calendar listing.
*
* @param int $hour If ommitted, now is assumed.
* @param int $minute If ommitted, now is assumed.
* @param int $second If ommitted, now is assumed.
* @param int $day If ommitted, now is assumed.
* @param int $month If ommitted, now is assumed.
* @param int $year If ommitted, now is assumed.
* @param int $duration Duration of event, remainder of the day is assumed.
*/
public function setCalendarTimeAndDuration($hour = NULL, $minute = NULL, $second = NULL, $day = NULL, $month = NULL, $year = NULL, $duration = NULL);
/**
* Return the start timestamp.
*/
public function getCalendarStartTime();
/**
* Return the end timestamp.
*/
public function getCalendarEndTime();
}
// All of these should either implemented in existing functions (with extra params) or new funcs
// get entities by time
// get entities by metadata
// get entities by relationship
// Implement get/set via metadata
/**
* Return a timestamp for the start of a given day (defaults today).
*
*/
function get_day_start($day = null, $month = null, $year = null) { return mktime(0,0,0,$month,$day,$year); }
/**
* Return a timestamp for the end of a given day (defaults today).
*
*/
function get_day_end($day = null, $month = null, $year = null) { return mktime(23,59,59,$month,$day,$year); }
/**
* Return the notable entities for a given time period.
*
* @param int $start_time The start time as a unix timestamp.
* @param int $end_time The end time as a unix timestamp.
* @param string $type The type of entity (eg "user", "object" etc)
* @param string $subtype The arbitrary subtype of the entity
* @param int $owner_guid The GUID of the owning user
* @param string $order_by The field to order by; by default, time_created desc
* @param int $limit The number of entities to return; 10 by default
* @param int $offset The indexing offset, 0 by default
* @param boolean $count Set to true to get a count rather than the entities themselves (limits and offsets don't apply in this context). Defaults to false.
* @param int $site_guid The site to get entities for. Leave as 0 (default) for the current site; -1 for all sites.
* @param int|array $container_guid The container or containers to get entities from (default: all containers).
*/
function get_notable_entities($start_time, $end_time, $type = "", $subtype = "", $owner_guid = 0, $order_by = "asc", $limit = 10, $offset = 0, $count = false, $site_guid = 0, $container_guid = null)
{
global $CONFIG;
if ($subtype === false || $subtype === null || $subtype === 0)
return false;
$start_time = (int)$start_time;
$end_time = (int)$end_time;
$order_by = sanitise_string($order_by);
$limit = (int)$limit;
$offset = (int)$offset;
$site_guid = (int) $site_guid;
if ($site_guid == 0)
$site_guid = $CONFIG->site_guid;
$where = array();
if (is_array($type)) {
$tempwhere = "";
if (sizeof($type))
foreach($type as $typekey => $subtypearray) {
foreach($subtypearray as $subtypeval) {
$typekey = sanitise_string($typekey);
if (!empty($subtypeval)) {
$subtypeval = (int) get_subtype_id($typekey, $subtypeval);
} else {
$subtypeval = 0;
}
if (!empty($tempwhere)) $tempwhere .= " or ";
$tempwhere .= "(e.type = '{$typekey}' and e.subtype = {$subtypeval})";
}
}
if (!empty($tempwhere)) $where[] = "({$tempwhere})";
} else {
$type = sanitise_string($type);
$subtype = get_subtype_id($type, $subtype);
if ($type != "")
$where[] = "e.type='$type'";
if ($subtype!=="")
$where[] = "e.subtype=$subtype";
}
if ($owner_guid != "") {
if (!is_array($owner_guid)) {
$owner_array = array($owner_guid);
$owner_guid = (int) $owner_guid;
$where[] = "e.owner_guid = '$owner_guid'";
} else if (sizeof($owner_guid) > 0) {
$owner_array = array_map('sanitise_int', $owner_guid);
// Cast every element to the owner_guid array to int
$owner_guid = implode(",",$owner_guid); //
$where[] = "e.owner_guid in ({$owner_guid})" ; //
}
if (is_null($container_guid)) {
$container_guid = $owner_array;
}
}
if ($site_guid > 0)
$where[] = "e.site_guid = {$site_guid}";
if (!is_null($container_guid)) {
if (is_array($container_guid)) {
foreach($container_guid as $key => $val) $container_guid[$key] = (int) $val;
$where[] = "e.container_guid in (" . implode(",",$container_guid) . ")";
} else {
$container_guid = (int) $container_guid;
$where[] = "e.container_guid = {$container_guid}";
}
}
// Add the calendar stuff
$cal_join = "
JOIN {$CONFIG->dbprefix}metadata cal_start on e.guid=cal_start.entity_guid
JOIN {$CONFIG->dbprefix}metastrings cal_start_name on cal_start.name_id=cal_start_name.id
JOIN {$CONFIG->dbprefix}metastrings cal_start_value on cal_start.value_id=cal_start_value.id
JOIN {$CONFIG->dbprefix}metadata cal_end on e.guid=cal_end.entity_guid
JOIN {$CONFIG->dbprefix}metastrings cal_end_name on cal_end.name_id=cal_end_name.id
JOIN {$CONFIG->dbprefix}metastrings cal_end_value on cal_end.value_id=cal_end_value.id
";
$where[] = "cal_start_name.string='calendar_start'";
$where[] = "cal_start_value.string>=$start_time";
$where[] = "cal_end_name.string='calendar_end'";
$where[] = "cal_end_value.string <= $end_time";
if (!$count) {
$query = "SELECT e.* from {$CONFIG->dbprefix}entities e $cal_join where ";
} else {
$query = "SELECT count(e.guid) as total from {$CONFIG->dbprefix}entities e $cal_join where ";
}
foreach ($where as $w)
$query .= " $w and ";
$query .= get_access_sql_suffix('e'); // Add access controls
if (!$count) {
$query .= " order by n.calendar_start $order_by";
if ($limit) $query .= " limit $offset, $limit"; // Add order and limit
$dt = get_data($query, "entity_row_to_elggstar");
return $dt;
} else {
$total = get_data_row($query);
return $total->total;
}
}
/**
* Return the notable entities for a given time period based on an item of metadata.
*
* @param int $start_time The start time as a unix timestamp.
* @param int $end_time The end time as a unix timestamp.
* @param mixed $meta_name
* @param mixed $meta_value
* @param string $entity_type The type of entity to look for, eg 'site' or 'object'
* @param string $entity_subtype The subtype of the entity.
* @param int $limit
* @param int $offset
* @param string $order_by Optional ordering.
* @param int $site_guid The site to get entities for. Leave as 0 (default) for the current site; -1 for all sites.
* @param true|false $count If set to true, returns the total number of entities rather than a list. (Default: false)
*
* @return int|array A list of entities, or a count if $count is set to true
*/
function get_notable_entities_from_metadata($start_time, $end_time, $meta_name, $meta_value = "", $entity_type = "", $entity_subtype = "", $owner_guid = 0, $limit = 10, $offset = 0, $order_by = "", $site_guid = 0, $count = false)
{
global $CONFIG;
$meta_n = get_metastring_id($meta_name);
$meta_v = get_metastring_id($meta_value);
$start_time = (int)$start_time;
$end_time = (int)$end_time;
$entity_type = sanitise_string($entity_type);
$entity_subtype = get_subtype_id($entity_type, $entity_subtype);
$limit = (int)$limit;
$offset = (int)$offset;
if ($order_by == "") $order_by = "e.time_created desc";
$order_by = sanitise_string($order_by);
$site_guid = (int) $site_guid;
if ((is_array($owner_guid) && (count($owner_guid)))) {
foreach($owner_guid as $key => $guid) {
$owner_guid[$key] = (int) $guid;
}
} else {
$owner_guid = (int) $owner_guid;
}
if ($site_guid == 0)
$site_guid = $CONFIG->site_guid;
//$access = get_access_list();
$where = array();
if ($entity_type!="")
$where[] = "e.type='$entity_type'";
if ($entity_subtype)
$where[] = "e.subtype=$entity_subtype";
if ($meta_name!="")
$where[] = "m.name_id='$meta_n'";
if ($meta_value!="")
$where[] = "m.value_id='$meta_v'";
if ($site_guid > 0)
$where[] = "e.site_guid = {$site_guid}";
if (is_array($owner_guid)) {
$where[] = "e.container_guid in (".implode(",",$owner_guid).")";
} else if ($owner_guid > 0)
$where[] = "e.container_guid = {$owner_guid}";
// Add the calendar stuff
$cal_join = "
JOIN {$CONFIG->dbprefix}metadata cal_start on e.guid=cal_start.entity_guid
JOIN {$CONFIG->dbprefix}metastrings cal_start_name on cal_start.name_id=cal_start_name.id
JOIN {$CONFIG->dbprefix}metastrings cal_start_value on cal_start.value_id=cal_start_value.id
JOIN {$CONFIG->dbprefix}metadata cal_end on e.guid=cal_end.entity_guid
JOIN {$CONFIG->dbprefix}metastrings cal_end_name on cal_end.name_id=cal_end_name.id
JOIN {$CONFIG->dbprefix}metastrings cal_end_value on cal_end.value_id=cal_end_value.id
";
$where[] = "cal_start_name.string='calendar_start'";
$where[] = "cal_start_value.string>=$start_time";
$where[] = "cal_end_name.string='calendar_end'";
$where[] = "cal_end_value.string <= $end_time";
if (!$count) {
$query = "SELECT distinct e.* ";
} else {
$query = "SELECT count(distinct e.guid) as total ";
}
$query .= "from {$CONFIG->dbprefix}entities e $cal_join JOIN {$CONFIG->dbprefix}metadata m on e.guid = m.entity_guid where";
foreach ($where as $w)
$query .= " $w and ";
$query .= get_access_sql_suffix("e"); // Add access controls
$query .= ' and ' . get_access_sql_suffix("m"); // Add access controls
if (!$count) {
$query .= " order by $order_by limit $offset, $limit"; // Add order and limit
return get_data($query, "entity_row_to_elggstar");
} else {
if ($row = get_data_row($query))
return $row->total;
}
return false;
}
/**
* Return the notable entities for a given time period based on their relationship.
*
* @param int $start_time The start time as a unix timestamp.
* @param int $end_time The end time as a unix timestamp.
* @param string $relationship The relationship eg "friends_of"
* @param int $relationship_guid The guid of the entity to use query
* @param bool $inverse_relationship Reverse the normal function of the query to instead say "give me all entities for whome $relationship_guid is a $relationship of"
* @param string $type
* @param string $subtype
* @param int $owner_guid
* @param string $order_by
* @param int $limit
* @param int $offset
* @param boolean $count Set to true if you want to count the number of entities instead (default false)
* @param int $site_guid The site to get entities for. Leave as 0 (default) for the current site; -1 for all sites.
* @return array|int|false An array of entities, or the number of entities, or false on failure
*/
function get_noteable_entities_from_relationship($start_time, $end_time, $relationship, $relationship_guid, $inverse_relationship = false, $type = "", $subtype = "", $owner_guid = 0, $order_by = "", $limit = 10, $offset = 0, $count = false, $site_guid = 0)
{
$start_time = (int)$start_time;
$end_time = (int)$end_time;
}
/**
* Get all entities for today.
*
* @param string $type The type of entity (eg "user", "object" etc)
* @param string $subtype The arbitrary subtype of the entity
* @param int $owner_guid The GUID of the owning user
* @param string $order_by The field to order by; by default, time_created desc
* @param int $limit The number of entities to return; 10 by default
* @param int $offset The indexing offset, 0 by default
* @param boolean $count Set to true to get a count rather than the entities themselves (limits and offsets don't apply in this context). Defaults to false.
* @param int $site_guid The site to get entities for. Leave as 0 (default) for the current site; -1 for all sites.
* @param int|array $container_guid The container or containers to get entities from (default: all containers).
*/
function get_todays_entities($type = "", $subtype = "", $owner_guid = 0, $order_by = "", $limit = 10, $offset = 0, $count = false, $site_guid = 0, $container_guid = null)
{
$day_start = get_day_start();
$day_end = get_day_end();
return get_notable_entities($day_start, $day_end, $type, $subtype, $owner_guid, $order_by, $limit, $offset, $count, $site_guid, $container_guid);
}
/**
* Get entities for today from metadata.
*
* @param mixed $meta_name
* @param mixed $meta_value
* @param string $entity_type The type of entity to look for, eg 'site' or 'object'
* @param string $entity_subtype The subtype of the entity.
* @param int $limit
* @param int $offset
* @param string $order_by Optional ordering.
* @param int $site_guid The site to get entities for. Leave as 0 (default) for the current site; -1 for all sites.
* @param true|false $count If set to true, returns the total number of entities rather than a list. (Default: false)
*
* @return int|array A list of entities, or a count if $count is set to true
*/
function get_todays_entities_from_metadata($meta_name, $meta_value = "", $entity_type = "", $entity_subtype = "", $owner_guid = 0, $limit = 10, $offset = 0, $order_by = "", $site_guid = 0, $count = false)
{
$day_start = get_day_start();
$day_end = get_day_end();
return get_notable_entities_from_metadata($day_start, $day_end, $meta_name, $meta_value, $entity_type, $entity_subtype, $owner_guid, $limit, $offset, $order_by, $site_guid, $count);
}
/**
* Get entities for today from a relationship
*
* @param string $relationship The relationship eg "friends_of"
* @param int $relationship_guid The guid of the entity to use query
* @param bool $inverse_relationship Reverse the normal function of the query to instead say "give me all entities for whome $relationship_guid is a $relationship of"
* @param string $type
* @param string $subtype
* @param int $owner_guid
* @param string $order_by
* @param int $limit
* @param int $offset
* @param boolean $count Set to true if you want to count the number of entities instead (default false)
* @param int $site_guid The site to get entities for. Leave as 0 (default) for the current site; -1 for all sites.
* @return array|int|false An array of entities, or the number of entities, or false on failure
*/
function get_todays_entities_from_relationship($relationship, $relationship_guid, $inverse_relationship = false, $type = "", $subtype = "", $owner_guid = 0, $order_by = "", $limit = 10, $offset = 0, $count = false, $site_guid = 0)
{
$day_start = get_day_start();
$day_end = get_day_end();
return get_notable_entities_from_relationship($day_start, $day_end, $relationship, $relationship_guid, $inverse_relationship, $type, $subtype, $owner_guid, $order_by, $limit, $offset, $count, $site_guid);
}
?>
|
