aboutsummaryrefslogtreecommitdiff
path: root/engine/lib/river2.php
diff options
context:
space:
mode:
authordave <dave@36083f99-b078-4883-b0ff-0f9b5a30f544>2010-03-10 16:28:50 +0000
committerdave <dave@36083f99-b078-4883-b0ff-0f9b5a30f544>2010-03-10 16:28:50 +0000
commit90c80171f9f089b4f2448c496e72d33432b5d724 (patch)
tree24a240d52bc79eaed762c0eb26ce8b185b59ff0c /engine/lib/river2.php
parent602abbf5ce303feb11a296a6bd3abc9b92368a41 (diff)
downloadelgg-90c80171f9f089b4f2448c496e72d33432b5d724.tar.gz
elgg-90c80171f9f089b4f2448c496e72d33432b5d724.tar.bz2
new activity river api functions
git-svn-id: http://code.elgg.org/elgg/trunk@5343 36083f99-b078-4883-b0ff-0f9b5a30f544
Diffstat (limited to 'engine/lib/river2.php')
-rw-r--r--engine/lib/river2.php229
1 files changed, 226 insertions, 3 deletions
diff --git a/engine/lib/river2.php b/engine/lib/river2.php
index 45a7f59ec..7793ea192 100644
--- a/engine/lib/river2.php
+++ b/engine/lib/river2.php
@@ -49,7 +49,7 @@ function add_to_river($view,$action_type,$subject_guid,$object_guid,$access_id =
global $CONFIG;
// Attempt to save river item; return success status
- return insert_data("insert into {$CONFIG->dbprefix}river " .
+ $insert_data = insert_data("insert into {$CONFIG->dbprefix}river " .
" set type = '{$type}', " .
" subtype = '{$subtype}', " .
" action_type = '{$action_type}', " .
@@ -59,6 +59,12 @@ function add_to_river($view,$action_type,$subject_guid,$object_guid,$access_id =
" object_guid = {$object_guid}, " .
" annotation_id = {$annotation_id}, " .
" posted = {$posted} ");
+
+ //update the entities which had the action carried out on it
+ if($insert_data){
+ update_entity_last_action($object_guid, $posted);
+ return $insert_data;
+ }
}
/**
@@ -246,6 +252,118 @@ function get_river_items($subject_guid = 0, $object_guid = 0, $subject_relations
}
/**
+ * Retrieves items from the river. All parameters are optional.
+ *
+ * @param int|array $subject_guid Acting entity to restrict to. Default: all
+ * @param int|array $object_guid Entity being acted on to restrict to. Default: all
+ * @param string $subject_relationship If set to a relationship type, this will use
+ * $subject_guid as the starting point and set the subjects to be all users this
+ * entity has this relationship with (eg 'friend'). Default: blank
+ * @param string $type The type of entity to restrict to. Default: all
+ * @param string $subtype The subtype of entity to restrict to. Default: all
+ * @param string $action_type The type of river action to restrict to. Default: all
+ * @param int $limit The number of items to retrieve. Default: 20
+ * @param int $offset The page offset. Default: 0
+ * @param int $posted_min The minimum time period to look at. Default: none
+ * @param int $posted_max The maximum time period to look at. Default: none
+ * @return array|false Depending on success
+ */
+function elgg_get_river_items($subject_guid = 0, $object_guid = 0, $subject_relationship = '', $type = '',
+ $subtype = '', $action_type = '', $limit = 10, $offset = 0, $posted_min = 0, $posted_max = 0) {
+
+ // Get config
+ global $CONFIG;
+
+ // Sanitise variables
+ if (!is_array($subject_guid)) {
+ $subject_guid = (int) $subject_guid;
+ } else {
+ foreach($subject_guid as $key => $temp) {
+ $subject_guid[$key] = (int) $temp;
+ }
+ }
+ if (!is_array($object_guid)) {
+ $object_guid = (int) $object_guid;
+ } else {
+ foreach($object_guid as $key => $temp) {
+ $object_guid[$key] = (int) $temp;
+ }
+ }
+ if (!empty($type)) {
+ $type = sanitise_string($type);
+ }
+ if (!empty($subtype)) {
+ $subtype = sanitise_string($subtype);
+ }
+ if (!empty($action_type)) {
+ $action_type = sanitise_string($action_type);
+ }
+ $limit = (int) $limit;
+ $offset = (int) $offset;
+ $posted_min = (int) $posted_min;
+ $posted_max = (int) $posted_max;
+
+ // Construct 'where' clauses for the river
+ $where = array();
+ $where[] = str_replace("and enabled='yes'",'',str_replace('owner_guid','subject_guid',get_access_sql_suffix_new('er','e')));
+
+ if (empty($subject_relationship)) {
+ if (!empty($subject_guid)) {
+ if (!is_array($subject_guid)) {
+ $where[] = " subject_guid = {$subject_guid} ";
+ } else {
+ $where[] = " subject_guid in (" . implode(',',$subject_guid) . ") ";
+ }
+ }
+ } else {
+ if (!is_array($subject_guid)) {
+ if ($entities = get_entities_from_relationship($subject_relationship,$subject_guid,false,'','',0,'',9999)) {
+ $guids = array();
+ foreach($entities as $entity) {
+ $guids[] = (int) $entity->guid;
+ }
+ // $guids[] = $subject_guid;
+ $where[] = " subject_guid in (" . implode(',',$guids) . ") ";
+ } else {
+ return array();
+ }
+ }
+ }
+ if (!empty($object_guid))
+ if (!is_array($object_guid)) {
+ $where[] = " object_guid = {$object_guid} ";
+ } else {
+ $where[] = " object_guid in (" . implode(',',$object_guid) . ") ";
+ }
+ if (!empty($type)) {
+ $where[] = " er.type = '{$type}' ";
+ }
+ if (!empty($subtype)) {
+ $where[] = " er.subtype = '{$subtype}' ";
+ }
+ if (!empty($action_type)) {
+ $where[] = " action_type = '{$action_type}' ";
+ }
+ if (!empty($posted_min)) {
+ $where[] = " posted > {$posted_min} ";
+ }
+ if (!empty($posted_max)) {
+ $where[] = " posted < {$posted_max} ";
+ }
+
+ $whereclause = implode(' and ', $where);
+
+ // Construct main SQL
+ $sql = "select er.*" .
+ " from {$CONFIG->dbprefix}river er, {$CONFIG->dbprefix}entities e " .
+ " where {$whereclause} AND er.object_guid = e.guid GROUP BY object_guid " .
+ " ORDER BY e.last_action desc LIMIT {$offset},{$limit}";
+
+ // Get data
+ return get_data($sql);
+}
+
+/**
* Returns a human-readable representation of a river item
*
* @see get_river_items
@@ -290,13 +408,20 @@ function elgg_view_river_item($item) {
* @return string Human-readable river.
*/
function elgg_view_river_items($subject_guid = 0, $object_guid = 0, $subject_relationship = '',
- $type = '', $subtype = '', $action_type = '', $limit = 20, $posted_min = 0, $posted_max = 0, $pagination = true) {
+ $type = '', $subtype = '', $action_type = '', $limit = 20, $posted_min = 0, $posted_max = 0, $pagination = true, $chronological = true) {
// Get input from outside world and sanitise it
$offset = (int) get_input('offset',0);
+ // Get the correct function
+ if($chronological == true){
+ $riveritems = get_river_items($subject_guid,$object_guid,$subject_relationship,$type,$subtype,$action_type,($limit + 1),$offset,$posted_min,$posted_max);
+ }else{
+ $riveritems = elgg_get_river_items($subject_guid,$object_guid,$subject_relationship,$type,$subtype,$action_type,($limit + 1),$offset,$posted_min,$posted_max);
+ }
+
// Get river items, if they exist
- if ($riveritems = get_river_items($subject_guid,$object_guid,$subject_relationship,$type,$subtype,$action_type,($limit + 1),$offset,$posted_min,$posted_max)) {
+ if ($riveritems) {
return elgg_view('river/item/list',array(
'limit' => $limit,
@@ -309,3 +434,101 @@ function elgg_view_river_items($subject_guid = 0, $object_guid = 0, $subject_rel
return '';
}
+/**
+ * Update last_action on the given entity.
+ *
+ * @param int $guid Entity annotation|relationship action carried out on
+ * @param int $posted Timestamp of last action
+ **/
+function update_entity_last_action($guid, $posted){
+ global $CONFIG;
+ if(!$posted)
+ $posted = time();
+ $guid = (int)$guid;
+ if($guid){
+ //now add to the river updated table
+ $query = update_data("UPDATE {$CONFIG->dbprefix}entities SET last_action = {$posted} WHERE guid = {$guid}");
+ if($query)
+ return true;
+ else
+ return false;
+ }else{
+ return false;
+ }
+}
+/**
+ * This function has been added here until we decide if it is going to roll into core or not
+ * Add access restriction sql code to a given query.
+ * Note that if this code is executed in privileged mode it will return blank.
+ * @TODO: DELETE once Query classes are fully integrated
+ *
+ * @param string $table_prefix Optional table. prefix for the access code.
+ * @param int $owner
+ */
+function get_access_sql_suffix_new($table_prefix_one = '', $table_prefix_two = '', $owner = null) {
+ global $ENTITY_SHOW_HIDDEN_OVERRIDE, $CONFIG;
+
+ $sql = "";
+ $friends_bit = "";
+ $enemies_bit = "";
+
+ if ($table_prefix_one) {
+ $table_prefix_one = sanitise_string($table_prefix_one) . ".";
+ }
+
+ if ($table_prefix_two) {
+ $table_prefix_two = sanitise_string($table_prefix_two) . ".";
+ }
+
+ if (!isset($owner)) {
+ $owner = get_loggedin_userid();
+ }
+
+ if (!$owner) {
+ $owner = -1;
+ }
+
+ $ignore_access = elgg_check_access_overrides($owner);
+ $access = get_access_list($owner);
+
+ if ($ignore_access) {
+ $sql = " (1 = 1) ";
+ } else if ($owner != -1) {
+ $friends_bit = "{$table_prefix_one}access_id = " . ACCESS_FRIENDS . "
+ AND {$table_prefix_one}owner_guid IN (
+ SELECT guid_one FROM {$CONFIG->dbprefix}entity_relationships
+ WHERE relationship='friend' AND guid_two=$owner
+ )";
+
+ $friends_bit = '('.$friends_bit.') OR ';
+
+ if ((isset($CONFIG->user_block_and_filter_enabled)) && ($CONFIG->user_block_and_filter_enabled)) {
+ // check to see if the user is in the entity owner's block list
+ // or if the entity owner is in the user's filter list
+ // if so, disallow access
+ $enemies_bit = get_annotation_sql('elgg_block_list', "{$table_prefix_one}owner_guid", $owner, false);
+ $enemies_bit = '('
+ . $enemies_bit
+ . ' AND ' . get_annotation_sql('elgg_filter_list', $owner, "{$table_prefix_one}owner_guid", false)
+ . ')';
+ }
+ }
+
+ if (empty($sql)) {
+ $sql = " $friends_bit ({$table_prefix_one}access_id IN {$access}
+ OR ({$table_prefix_one}owner_guid = {$owner})
+ OR (
+ {$table_prefix_one}access_id = " . ACCESS_PRIVATE . "
+ AND {$table_prefix_one}owner_guid = $owner
+ )
+ )";
+ }
+
+ if ($enemies_bit) {
+ $sql = "$enemies_bit AND ($sql)";
+ }
+
+ if (!$ENTITY_SHOW_HIDDEN_OVERRIDE)
+ $sql .= " and {$table_prefix_two}enabled='yes'";
+ return '('.$sql.')';
+} \ No newline at end of file