aboutsummaryrefslogtreecommitdiff
path: root/engine/lib/objects.php
diff options
context:
space:
mode:
Diffstat (limited to 'engine/lib/objects.php')
-rw-r--r--engine/lib/objects.php643
1 files changed, 120 insertions, 523 deletions
diff --git a/engine/lib/objects.php b/engine/lib/objects.php
index f939b0ce5..ff3cc733f 100644
--- a/engine/lib/objects.php
+++ b/engine/lib/objects.php
@@ -1,523 +1,120 @@
-<?php
-
- /**
- * Elgg objects
- * Forms the basis of object storage and retrieval
- *
- * @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/
- */
-
- /**
- * Converts a standard database row result to an ElggObject
- *
- * @param object $row The database row object
- * @return ElggObject The formatted ElggObject
- */
- function row_to_elggobject($row) {
- if (empty($row))
- return $row;
-
- return new ElggObject($row);
- }
-
- /**
- * Get object reverse ordered by publish time, optionally filtered by user and/or type
- *
- * @param int $user_id The ID of the publishing user; set to 0 for all users
- * @param string $type The type of the object; set to blank for all types
- * @param string $metadata_type The type of metadata that we're searching on (blank for none)
- * @param string $metadata_value The value of metadata that we're searching on (blank for none)
- * @param int $limit The number of objects (default 10)
- * @param int $offset The offset of the return, for pagination
- * @param int $site_id The site the objects belong to (leave blank for default site)
- * @return unknown
- */
- function get_objects($user_id = 0, $type = "", $metadata_type = "", $metadata_value = "", $limit = 10, $offset = 0, $site_id = 0) {
-
- global $CONFIG;
-
- $user_id = (int) $user_id;
- $type = sanitise_string($type);
- $limit = (int) $limit;
- $offset = (int) $offset;
- $site_id = (int) $site_id;
- if ($site_id == 0) $site_id = $CONFIG->site_id;
- $access = get_access_list();
-
- $query = "select o.*, ot.name as typename from {$CONFIG->dbprefix}objects o ";
- if (!empty($type)) $query .= " left join {$CONFIG->dbprefix}object_types ot on ot.id = o.type_id ";
- if (!empty($metadata_type) && !empty($metadata_value)) {
- $metadata_type = sanitise_string($metadata_type);
- $metadata_value = sanitise_string($metadata_value);
- $query .= " left join {$CONFIG->dbprefix}object_metadata om on om.object_id = o.id ";
- $query .= " left join {$CONFIG->dbprefix}metadata_value mv on mv.id = om.value_id ";
- $query .= " left join {$CONFIG->dbprefix}metadata_type mt on mt.id = om.metadata_type_id ";
- }
- $query .= " where o.site_id = {$site_id} ";
- $query .= " and (o.access_id in {$access} or (o.access_id = 0 and o.owner_id = {$_SESSION['id']}))";
- if (!empty($type)) $query .= " and ot.name = '{$type}'";
- if ($user_id > 0) $query .= " and o.owner_id = {$user_id} ";
- if (!empty($metadata_type) && !empty($metadata_value)) {
- $query .= " and mv.value = '{$metadata_value}' and mt.name = '{$metadata_type}' ";
- $query .= " and (om.access_id in {$access} or (om.access_id = 0 and o.owner_id = {$_SESSION['id']}))";
- }
- $query .= " order by o.time_created desc ";
- if ($limit > 0 || $offset > 0) $query .= " limit {$offset}, {$limit}";
-
- return get_data($query,"row_to_elggobject");
-
- }
-
- /**
- * Retrieves details about an object, if the current user is allowed to see it
- *
- * @param int $object_id The ID of the object to load
- * @return object A database representation of the object
- */
- function get_object($object_id) {
-
- global $CONFIG;
-
- $object_id = (int) $object_id;
- $access = get_access_list();
-
- $row = get_data_row("select o.*, ot.name as typename from {$CONFIG->dbprefix}objects left join {$CONFIG->dbprefix}object_types ot on ot.id = o.type_id where (o.access_id in {$access} or (o.access_id = 0 and o.owner_id = {$_SESSION['id']}))");
- return row_to_elggobject($row);
-
- }
-
- /**
- * Deletes an object and all accompanying metadata
- *
- * @param int $object_id The ID of the object
- * @return true|false Depending on success
- */
- function delete_object($object_id) {
-
- global $CONFIG;
-
- $object_id = (int) $object_id;
- $access = get_access_list();
-
- if (delete_data("delete from {$CONFIG->dbprefix}objects where o.id = {$object_id} and o.owner_id = {$_SESSION['id']}")) {
- remove_object_metadata($object_id);
- return true;
- }
-
- return false;
- }
-
- /**
- * Creates an object
- *
- * @param string $title Object title
- * @param string $description A description of the object
- * @param string $type The textual type of the object (eg "blog")
- * @param int $owner The owner of the object (defaults to currently logged in user)
- * @param int $access_id The access restriction on the object (defaults to private)
- * @param int $site_id The site the object belongs to
- * @return int The ID of the newly-inserted object
- */
- function create_object($title, $description, $type, $owner = 0, $access_id = 0, $site_id = 0) {
-
- global $CONFIG;
-
- $title = sanitise_string($title);
- $description = sanitise_string($description);
- $owner = (int) $owner;
- $site_id = (int) $site_id;
- $access_id = (int) $access_id;
- if ($site_id == 0) $site_id = $CONFIG->site_id;
- if ($owner == 0) $owner = $_SESSION['id'];
-
- // We can't let non-logged in users create data
- // We also need the access restriction to be valid
- if ($owner > 0 && in_array($access_id,get_access_array())) {
-
- $type_id = get_object_type_id($type);
-
- $query = " insert into {$CONFIG->dbprefix}objects ";
- $query .= "(`title`,`description`,`type_id`,`owner_id`,`site_id`,`access_id`) values ";
- $query .= "('{$title}','{$description}', {$type_id}, {$owner}, {$site_id}, {$access_id}";
- return insert_data($query);
-
- }
- return false;
-
- }
-
- /**
- * Update an object
- * Note that to write to an object, you must be logged in as the owner
- *
- * @param int $id The ID of the object
- * @param string $title Object title
- * @param string $description A description of the object
- * @param string $type The textual type of the object (eg "blog")
- * @param int $owner The owner of the object (defaults to currently logged in user)
- * @param int $access_id The access restriction on the object (defaults to private)
- * @param int $site_id The site the object belongs to
- * @return int|false Either 1 or 0 (the number of objects updated) or false on failure
- */
-
- function update_object($id, $title = null, $description = null, $type = null, $owner_id = null, $access_id = null, $site_id = null) {
-
- global $CONFIG;
-
- $id = (int) $id;
- if ($title != null) $title = sanitise_string($title);
- if ($description != null) $description = sanitise_string($description);
- if ($owner_id != null) $owner_id = (int) $owner_id;
- if ($site_id != null) $site_id = (int) $site_id;
- if ($access_id != null) $access_id = (int) $access_id;
- if ($site_id != null) if ($site_id == 0) $site_id = $CONFIG->site_id;
- if ($owner_id != null) if ($owner_id == 0) $owner = $_SESSION['id'];
-
- // We can't let non-logged in users create data
- // We also need the access restriction to be valid
- if ($owner > 0 && in_array($access_id,get_access_array())) {
-
- $params = array();
- foreach(array('title','description','owner','site_id','access_id','site_id','owner') as $param) {
- if ($$param != null) {
- $params[] = "{$param} = '{$$param}'";
- }
- }
-
- return update_data("update {$CONFIG->prefix}objects set " . implode(",",$params) . " where id = {$id} and owner_id = {$_SESSION['id']}");
-
- }
- return false;
-
- }
-
- /**
- * Gets the ID of an object type in the database, setting it if necessary
- *
- * @param string $type The name of the object type
- * @return int|false The database ID of the object type, or false if the given type was invalid
- */
- function get_object_type_id($type) {
-
- global $CONFIG;
-
- $type = strtolower(trim(sanitise_string($type)));
- if (!empty($type) && $dbtype = get_data_row("select id from {$CONFIG->dbprefix}object_types where name = '{$type}'")) {
- return $dbtype->id;
- } else if (!empty($type)) {
- return insert_data("insert into {$CONFIG->dbprefix}object_types set name = '{$type}'");
- }
- return false;
-
- }
-
- /**
- * Gets the ID of an object metadata type in the database, setting it if necessary
- *
- * @param string $type The name of the metadata type
- * @return int|false The database ID of the metadata type, or false if the given type was invalid
- */
- function get_metadata_type_id($type) {
-
- global $CONFIG;
- $type = strtolower(trim(sanitise_string($type)));
- if (!empty($type) && $dbtype = get_data_row("select id from {$CONFIG->dbprefix}metadata_type where name = '{$type}'")) {
- return $dbtype->id;
- } else if (!empty($type)) {
- return insert_data("insert into {$CONFIG->dbprefix}metadata_type set name = '{$type}'");
- }
- return false;
-
- }
-
- /**
- * Gets the ID of an object metadata value in the database, setting it if necessary
- *
- * @param string $type The metadata value
- * @return int|false The database ID of the metadata value, or false if the given value was invalid
- */
- function get_metadata_value_id($value) {
-
- global $CONFIG;
- $type = strtolower(trim(sanitise_string($value)));
- if (!empty($value) && $dbtype = get_data_row("select id from {$CONFIG->dbprefix}metadata_value where value = '{$value}'")) {
- return $dbtype->id;
- } else if (!empty($value)) {
- return insert_data("insert into {$CONFIG->dbprefix}metadata_value set value = '{$value}'");
- }
- return false;
-
- }
-
- /**
- * Sets a piece of metadata for a particular object.
- *
- * @param string $metadata_name The type of metadata
- * @param string $metadata_value Its value
- * @param int $access_id The access level of the metadata
- * @param int $object_id The ID of the object
- * @return true|false depending on success
- */
- function set_object_metadata($metadata_name, $metadata_value, $access_id, $object_id, $site_id = 0) {
- global $CONFIG;
- $object_id = (int) $object_id;
- if ($object = get_object($object_id)) {
- if ($object->owner_id == $_SESSION['id']) {
-
- $access_id = (int) $access_id;
- if ($site_id == 0) $site_id = $CONFIG->site_id;
- $site_id = (int) $site_id;
-
- if ($type_id = get_object_metadata_type_id($metadata_name)
- && $value_id = get_object_metadata_value_id($metadata_value)
- && in_array($access_id,get_access_array())) {
- delete_data("delete from {$CONFIG->dbprefix}object_metadata where metadata_type_id = {$type_id} and object_id = {$object_id}");
- return insert_data("insert into {$CONFIG->dbprefix}object_metadata set object_id = {$object_id}, access_id = {$access_id}, metadata_type_id = {$type_id}, value_id = {$value_id}, site_id = {$site_id}");
- } else {
- return false;
- }
-
- }
- } else {
- return false;
- }
- }
-
- /**
- * Returns the value of a particular piece of metadata on an object
- *
- * @param string $metadata_name The name of the metadata
- * @param int $object_id The object ID
- * @param int $site_id The site ID, optionally
- * @return mixed The value of the metadata
- */
- function get_object_metadata($metadata_name, $object_id, $site_id = 0) {
-
- if ($type_id = get_metadata_type_id($metadata_name)) {
-
- $accesslist = get_access_list();
- $object_id = (int) $objet_id;
- if ($site_id == 0) $site_id = $CONFIG->site_id;
- $site_id = (int) $site_id;
-
- if ($result = get_data_row("select mv.value from object_metadata om left join metadata_value mv on mv.id = om.value_id where om.object_id = {$object_id} and om.site_id = {$site_id} and om.metadata_type_id = {$type_id}")) {
- return $result->value;
- }
- return false;
-
- }
-
- }
-
- /**
- * Removes a piece of (or all) metadata for a particular object.
- *
- * @param int $object_id The ID of the object
- * @param string $metadata_name The type of metadata; blank for all metadata
- * @return true|false depending on success
- */
- function remove_object_metadata($object_id, $metadata_name = "") {
- global $CONFIG;
- $object_id = (int) $object_id;
- if ($object = get_object($object_id)) {
- if ($object->owner_id == $_SESSION['id']) {
-
- if ($type_id = get_object_metadata_type_id($metadata_name)) {
- return delete_data("delete from {$CONFIG->dbprefix}object_metadata where metadata_type_id = {$type_id} and object_id = {$object_id}");
- } else {
- return false;
- }
-
- }
- } else {
- return false;
- }
- return true;
- }
-
- /**
- * This class represents an Elgg object.
- *
- */
- class ElggObject {
-
- private $attributes = array();
-
- function __get($name) {
-
- if (isset($this->attributes[$name])) {
- return $this->attributes[$name];
- }
- return null;
- }
-
- function __set($name, $value) {
- $this->attributes[$name] = $value;
- return true;
- }
-
- function __construct($id = null) {
-
- $this->attributes = array();
-
- if (!empty($id)) {
- if ($id instanceof stdClass)
- $object = $id; // Create from db row
- else
- $object = get_object($id);
-
- if ($object) {
- $objarray = (array) $object;
- foreach($objarray as $key => $value) {
- $this->attributes[$key] = $value;
- }
- }
- }
- }
-
-
- /**
- * Obtains the parent site
- *
- * @return ElggSite The parent site
- */
- function getSite() {
- // TODO: gets the parent site
- }
-
-
-
- /**
- * Returns the value of a particular piece of metadata
- *
- * @param string $name The name of the metadata
- * @return mixed|false The metadata value; false on failure
- */
- function getMetadata($name) {
- if (!empty($this->id)) {
- return get_object_metadata($name, $this->id, $this->site_id);
- }
- return false;
- }
-
- /**
- * Adds metadata for this object
- *
- * @uses set_object_metadata
- * @param string $name The name of the metadata type
- * @param string $value The value for the metadata to set
- * @param int $access_id The access level for this piece of metadata (default: private)
- * @return true|false Depending on success
- */
- function setMetadata($name, $value, $access_id = 0) {
- if (!empty($this->id)) {
- return set_object_metadata($name, $value, $access_id, $this->id, $this->site_id);
- }
- return false;
- }
-
- /**
- * Clears metadata for this object, either for a particular type or across the board
- *
- * @uses remove_object_metadata
- * @param string $name Optionally, the name of the metadata to remove
- * @return true|false Depending on success
- */
- function clearMetadata($name = "") {
- if (!empty($this->id)) {
- return remove_object_metadata($this->id, $name);
- }
- return false;
- }
-
- /**
- * Adds an annotation to an object
- *
- * @param string $name Name of the annotation type
- * @param string|int $value The annotation value
- * @param int $access_id The access level for the annotation
- * @param int $owner_id The annotation owner
- * @param string $vartype Optionally, the variable type of the annotation (eg "int")
- */
- function annotate($name, $value, $access_id = 0, $owner_id = 0, $vartype = "") {
- // TODO: add annotation
- }
-
- /**
- * Returns the object's annotations of a particular type (eg "comment")
- *
- * @param string $name The type of annotation
- * @param int $limit Number of annotations to get
- * @param int $offset Any offset
- */
- function getAnnotations($name, $limit = 50, $offset = 0) {
- // TODO: get annotations
- }
-
- /**
- * Gets the average of the integer annotations on this object
- *
- * @param string $name Optionally, the type of annotation
- */
- function getAnnotationsAvg($name) {
- }
-
- /**
- * Gets the sum of the integer annotations on this object
- *
- * @param string $name Optionally, the type of annotation
- */
- function getAnnotationsSum($name) {
- }
-
- /**
- * Gets the minimum value of the integer annotations on this object
- *
- * @param string $name Optionally, the type of annotation
- */
- function getAnnotationsMin($name) {
- }
-
- /**
- * Gets the maximum value of the integer annotations on this object
- *
- * @param string $name Optionally, the type of annotation
- */
- function getAnnotationsMax($name) {
- }
-
- /**
- * Inserts or updates the object, depending on whether it's new or not
- *
- * @return true|false Depending on success
- */
- function save() {
- if (!empty($this->id)) {
- return update_object($this->id, $this->title, $this->description, $this->type, $this->owner_id, $this->access_id, $this->site_id);
- } else if ($id = create_object($this->title,$this->description,$this->type,$this->owner_id,$this->access_id,$this->site_id)) {
- $this->id = $id;
- return true;
- }
- }
-
- /**
- * Deletes this object
- *
- * @uses delete_object
- * @return int|false The number of objects deleted, or false on failure
- */
- function delete() {
- if (!empty($this->id)) {
- return delete_object($this->id);
- }
- return false;
- }
-
- }
-
-?> \ No newline at end of file
+<?php
+/**
+ * Elgg objects
+ * Functions to manage multiple or single objects in an Elgg install
+ *
+ * @package Elgg
+ * @subpackage Core
+ */
+
+/**
+ * Return the object specific details of a object by a row.
+ *
+ * @param int $guid The guid to retreive
+ *
+ * @return bool
+ * @access private
+ */
+function get_object_entity_as_row($guid) {
+ global $CONFIG;
+
+ $guid = (int)$guid;
+ return get_data_row("SELECT * from {$CONFIG->dbprefix}objects_entity where guid=$guid");
+}
+
+/**
+ * Create or update the extras table for a given object.
+ * Call create_entity first.
+ *
+ * @param int $guid The guid of the entity you're creating (as obtained by create_entity)
+ * @param string $title The title of the object
+ * @param string $description The object's description
+ *
+ * @return bool
+ * @access private
+ */
+function create_object_entity($guid, $title, $description) {
+ global $CONFIG;
+
+ $guid = (int)$guid;
+ $title = sanitise_string($title);
+ $description = sanitise_string($description);
+
+ $row = get_entity_as_row($guid);
+
+ if ($row) {
+ // Core entities row exists and we have access to it
+ $query = "SELECT guid from {$CONFIG->dbprefix}objects_entity where guid = {$guid}";
+ if ($exists = get_data_row($query)) {
+ $query = "UPDATE {$CONFIG->dbprefix}objects_entity
+ set title='$title', description='$description' where guid=$guid";
+
+ $result = update_data($query);
+ if ($result != false) {
+ // Update succeeded, continue
+ $entity = get_entity($guid);
+ elgg_trigger_event('update', $entity->type, $entity);
+ return $guid;
+ }
+ } else {
+ // Update failed, attempt an insert.
+ $query = "INSERT into {$CONFIG->dbprefix}objects_entity
+ (guid, title, description) values ($guid, '$title','$description')";
+
+ $result = insert_data($query);
+ if ($result !== false) {
+ $entity = get_entity($guid);
+ if (elgg_trigger_event('create', $entity->type, $entity)) {
+ return $guid;
+ } else {
+ $entity->delete();
+ }
+ }
+ }
+ }
+
+ return false;
+}
+
+/**
+ * Get the sites this object is part of
+ *
+ * @param int $object_guid The object's GUID
+ * @param int $limit Number of results to return
+ * @param int $offset Any indexing offset
+ *
+ * @return false|array On success, an array of ElggSites
+ */
+function get_object_sites($object_guid, $limit = 10, $offset = 0) {
+ $object_guid = (int)$object_guid;
+ $limit = (int)$limit;
+ $offset = (int)$offset;
+
+ return elgg_get_entities_from_relationship(array(
+ 'relationship' => 'member_of_site',
+ 'relationship_guid' => $object_guid,
+ 'type' => 'site',
+ 'limit' => $limit,
+ 'offset' => $offset,
+ ));
+}
+
+/**
+ * Runs unit tests for ElggObject
+ *
+ * @param string $hook unit_test
+ * @param string $type system
+ * @param mixed $value Array of tests
+ * @param mixed $params Params
+ *
+ * @return array
+ * @access private
+ */
+function objects_test($hook, $type, $value, $params) {
+ global $CONFIG;
+ $value[] = "{$CONFIG->path}engine/tests/objects/objects.php";
+ return $value;
+}
+
+elgg_register_event_handler('init', 'system', 'objects_init', 0);
+elgg_register_plugin_hook_handler('unit_test', 'system', 'objects_test');
generated by cgit v1.2.3 (git 2.39.1) at 2025-11-14 22:10:24 +0000