mbk-lab
/
nextcloud
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Added separate table for OC_VCategories and category/object (event/contact etc.) relations.

This commit is contained in:
Thomas Tanghus 2012-09-17 16:03:15 +02:00
parent ffe04182a8
commit b1a6acde30
2 changed files with 430 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

138
db_structure.xml
View File

@ -661,4 +661,142 @@
</table> </table>
<table>
<name>*dbprefix*vcategory</name>
<declaration>
<field>
<name>id</name>
<type>integer</type>
<default>0</default>
<notnull>true</notnull>
<autoincrement>1</autoincrement>
<unsigned>true</unsigned>
<length>4</length>
</field>
<field>
<name>uid</name>
<type>text</type>
<default></default>
<notnull>true</notnull>
<length>64</length>
</field>
<field>
<name>type</name>
<type>text</type>
<default></default>
<notnull>true</notnull>
<length>64</length>
</field>
<field>
<name>category</name>
<type>text</type>
<default></default>
<notnull>true</notnull>
<length>255</length>
</field>
<index>
<name>uid_index</name>
<field>
<name>uid</name>
<sorting>ascending</sorting>
</field>
</index>
<index>
<name>type_index</name>
<field>
<name>type</name>
<sorting>ascending</sorting>
</field>
</index>
<index>
<name>category_index</name>
<field>
<name>category</name>
<sorting>ascending</sorting>
</field>
</index>
<index>
<name>uid_type_category_index</name>
<unique>true</unique>
<field>
<name>uid</name>
<sorting>ascending</sorting>
</field>
<field>
<name>type</name>
<sorting>ascending</sorting>
</field>
<field>
<name>category</name>
<sorting>ascending</sorting>
</field>
</index>
</declaration>
</table>
<table>
<name>*dbprefix*vcategory_to_object</name>
<declaration>
<field>
<name>objid</name>
<type>integer</type>
<default>0</default>
<notnull>true</notnull>
<unsigned>true</unsigned>
<length>4</length>
</field>
<field>
<name>categoryid</name>
<type>integer</type>
<default>0</default>
<notnull>true</notnull>
<unsigned>true</unsigned>
<length>4</length>
</field>
<field>
<name>type</name>
<type>text</type>
<default></default>
<notnull>true</notnull>
<length>64</length>
</field>
<index>
<primary>true</primary>
<unique>true</unique>
<name>category_object_index</name>
<field>
<name>categoryid</name>
<sorting>ascending</sorting>
</field>
<field>
<name>objid</name>
<sorting>ascending</sorting>
</field>
<field>
<name>type</name>
<sorting>ascending</sorting>
</field>
</index>
</declaration>
</table>
</database> </database>

339
lib/vcategories.php
View File

@ -28,52 +28,187 @@
* anything else that is either parsed from a vobject or that the user chooses * anything else that is either parsed from a vobject or that the user chooses
* to add. * to add.
* Category names are not case-sensitive, but will be saved with the case they * Category names are not case-sensitive, but will be saved with the case they
* are entered in. If a user already has a category 'family' for an app, and * are entered in. If a user already has a category 'family' for a type, and
* tries to add a category named 'Family' it will be silently ignored. * tries to add a category named 'Family' it will be silently ignored.
* NOTE: There is a limitation in that the the configvalue field in the
* preferences table is a varchar(255).
*/ */
class OC_VCategories { class OC_VCategories {
const PREF_CATEGORIES_LABEL = 'extra_categories';
/** /**
* Categories * Categories
*/ */
private $categories = array(); private $categories = array();
/**
* Used for storing objectid/categoryname pairs while rescanning.
*/
private static $relations = array();
private $app = null; private $type = null;
private $user = null; private $user = null;
private static $category_table = '*PREFIX*vcategory';
private static $relation_table = '*PREFIX*vcategory_to_object';
const FORMAT_LIST = 0;
const FORMAT_MAP = 1;
/** /**
* @brief Constructor. * @brief Constructor.
* @param $app The application identifier e.g. 'contacts' or 'calendar'. * @param $type The type identifier e.g. 'contact' or 'event'.
* @param $user The user whos data the object will operate on. This * @param $user The user whos data the object will operate on. This
* parameter should normally be omitted but to make an app able to * parameter should normally be omitted but to make an app able to
* update categories for all users it is made possible to provide it. * update categories for all users it is made possible to provide it.
* @param $defcategories An array of default categories to be used if none is stored. * @param $defcategories An array of default categories to be used if none is stored.
*/ */
public function __construct($app, $user=null, $defcategories=array()) { public function __construct($type, $user=null, $defcategories=array()) {
$this->app = $app; $this->type = $type;
$this->user = is_null($user) ? OC_User::getUser() : $user; $this->user = is_null($user) ? OC_User::getUser() : $user;
$categories = trim(OC_Preferences::getValue($this->user, $app, self::PREF_CATEGORIES_LABEL, ''));
if ($categories) { $this->loadCategories();
$categories = @unserialize($categories); OCP\Util::writeLog('core', __METHOD__ . ', categories: '
. print_r($this->categories, true),
OCP\Util::DEBUG
);
if($defcategories && count($this->categories) === 0) {
$this->add($defcategories, true);
} }
$this->categories = is_array($categories) ? $categories : $defcategories;
} }
/**
* @brief Load categories from db.
*/
private function loadCategories() {
$this->categories = array();
$result = null;
$sql = 'SELECT `id`, `category` FROM `*PREFIX*vcategory` '
. 'WHERE `uid` = ? AND `type` = ? ORDER BY `category`';
try {
$stmt = OCP\DB::prepare($sql);
$result = $stmt->execute(array($this->user, $this->type));
} catch(Exception $e) {
OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
OCP\Util::ERROR);
}
if(!is_null($result)) {
while( $row = $result->fetchRow()) {
// The keys are prefixed because array_search wouldn't work otherwise :-/
$this->categories[$row['id']] = $row['category'];
}
}
}
/**
* @brief Check if any categories are saved for this type and user.
* @returns boolean.
* @param $type The type identifier e.g. 'contact' or 'event'.
* @param $user The user whos categories will be checked. If not set current user will be used.
*/
public static function isEmpty($type, $user = null) {
$user = is_null($user) ? OC_User::getUser() : $user;
$sql = 'SELECT COUNT(*) FROM `*PREFIX*vcategory` '
. 'WHERE `uid` = ? AND `type` = ? ORDER BY `category`';
try {
$stmt = OCP\DB::prepare($sql);
$result = $stmt->execute(array($user, $type));
return ($result->numRows() == 0);
} catch(Exception $e) {
OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
OCP\Util::ERROR);
return false;
}
}
/** /**
* @brief Get the categories for a specific user. * @brief Get the categories for a specific user.
* @param
* @returns array containing the categories as strings. * @returns array containing the categories as strings.
*/ */
public function categories() { public function categories($format = null) {
//OC_Log::write('core','OC_VCategories::categories: '.print_r($this->categories, true), OC_Log::DEBUG);
if(!$this->categories) { if(!$this->categories) {
return array(); return array();
} }
usort($this->categories, 'strnatcasecmp'); // usort to also renumber the keys $categories = array_values($this->categories);
return $this->categories; uasort($categories, 'strnatcasecmp');
if($format == self::FORMAT_MAP) {
$catmap = array();
foreach($categories as $category) {
$catmap[] = array(
'id' => $this->array_searchi($category, $this->categories),
'name' => $category
);
}
return $catmap;
}
return $categories;
} }
/**
* @brief Get the a list if items belonging to $category.
* @param string|integer $category Category id or name.
* @param string $table The name of table to query.
* @param int $limit
* @param int $offset
*
* This generic method queries a table assuming that the id
* field is called 'id' and the table name provided is in
* the form '*PREFIX*table_name'.
*
* If the category name cannot be resolved an exception is thrown.
*
* TODO: Maybe add the getting permissions for objects?
*
* @returns array containing the resulting items.
*/
public function itemsForCategory($category, $tableinfo, $limit = null, $offset = null) {
$result = null;
if(is_numeric($category)) {
$catid = $category;
} elseif(is_string($category)) {
$catid = $this->array_searchi($category, $this->categories);
}
OCP\Util::writeLog('core', __METHOD__.', category: '.$catid.' '.$category, OCP\Util::DEBUG);
if($catid === false) {
$l10n = OC_L10N::get('core');
throw new Exception(
$l10n->t(
'Could not find category "%s"', $category
)
);
}
$fields = '';
foreach($tableinfo['fields'] as $field) {
$fields .= '`' . $tableinfo['tablename'] . '`.`' . $field . '`,';
}
$fields = substr($fields, 0, -1);
$items = array();
$sql = 'SELECT `' . self::$relation_table . '`.`categoryid`, ' . $fields
. ' FROM `' . $tableinfo['tablename'] . '` JOIN `'
. self::$relation_table . '` ON `' . $tableinfo['tablename']
. '`.`id` = `' . self::$relation_table . '`.`objid` WHERE `'
. self::$relation_table . '`.`categoryid` = ?';
try {
$stmt = OCP\DB::prepare($sql, $limit, $offset);
$result = $stmt->execute(array($catid));
} catch(Exception $e) {
OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
OCP\Util::ERROR);
}
if(!is_null($result)) {
while( $row = $result->fetchRow()) {
$items[] = $row;
}
}
//OCP\Util::writeLog('core', __METHOD__.', count: ' . count($items), OCP\Util::DEBUG);
//OCP\Util::writeLog('core', __METHOD__.', sql: ' . $sql, OCP\Util::DEBUG);
return $items;
}
/** /**
* @brief Checks whether a category is already saved. * @brief Checks whether a category is already saved.
* @param $name The name to check for. * @param $name The name to check for.
@ -90,16 +225,21 @@ class OC_VCategories {
* @param $sync bool When true, save the categories * @param $sync bool When true, save the categories
* @returns bool Returns false on error. * @returns bool Returns false on error.
*/ */
public function add($names, $sync=false) { public function add($names, $sync=false, $id = null) {
if(!is_array($names)) { if(!is_array($names)) {
$names = array($names); $names = array($names);
} }
$names = array_map('trim', $names); $names = array_map('trim', $names);
$newones = array(); $newones = array();
foreach($names as $name) { foreach($names as $name) {
if(($this->in_arrayi($name, $this->categories) == false) && $name != '') { if(($this->in_arrayi(
$name, $this->categories) == false) && $name != '') {
$newones[] = $name; $newones[] = $name;
} }
if(!is_null($id) ) {
// Insert $objectid, $categoryid pairs if not exist.
self::$relations[] = array('objid' => $id, 'category' => $name);
}
} }
if(count($newones) > 0) { if(count($newones) > 0) {
$this->categories = array_merge($this->categories, $newones); $this->categories = array_merge($this->categories, $newones);
@ -114,8 +254,8 @@ class OC_VCategories {
* @brief Extracts categories from a vobject and add the ones not already present. * @brief Extracts categories from a vobject and add the ones not already present.
* @param $vobject The instance of OC_VObject to load the categories from. * @param $vobject The instance of OC_VObject to load the categories from.
*/ */
public function loadFromVObject($vobject, $sync=false) { public function loadFromVObject($id, $vobject, $sync=false) {
$this->add($vobject->getAsArray('CATEGORIES'), $sync); $this->add($vobject->getAsArray('CATEGORIES'), $sync, $id);
} }
/** /**
@ -128,23 +268,54 @@ class OC_VCategories {
* $result = $stmt->execute(); * $result = $stmt->execute();
* $objects = array(); * $objects = array();
* if(!is_null($result)) { * if(!is_null($result)) {
* while( $row = $result->fetchRow()) { * while( $row = $result->fetchRow()){
* $objects[] = $row['carddata']; * $objects[] = array($row['id'], $row['carddata']);
* } * }
* } * }
* $categories->rescan($objects); * $categories->rescan($objects);
*/ */
public function rescan($objects, $sync=true, $reset=true) { public function rescan($objects, $sync=true, $reset=true) {
if($reset === true) {
if($reset === true) {
$result = null;
// Find all objectid/categoryid pairs.
try {
$stmt = OCP\DB::prepare('SELECT `id` FROM `*PREFIX*vcategory` '
. 'WHERE `uid` = ? AND `type` = ?');
$result = $stmt->execute(array($this->user, $this->type));
} catch(Exception $e) {
OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
OCP\Util::ERROR);
}
// And delete them.
if(!is_null($result)) {
$stmt = OCP\DB::prepare('DELETE FROM `*PREFIX*vcategory_to_object` '
. 'WHERE `categoryid` = ? AND `type`= ?');
while( $row = $result->fetchRow()) {
$stmt->execute(array($row['id'], $this->type));
}
}
try {
$stmt = OCP\DB::prepare('DELETE FROM `*PREFIX*vcategory` '
. 'WHERE `uid` = ? AND `type` = ?');
$result = $stmt->execute(array($this->user, $this->type));
} catch(Exception $e) {
OCP\Util::writeLog('core', __METHOD__ . ', exception: '
. $e->getMessage(), OCP\Util::ERROR);
return;
}
$this->categories = array(); $this->categories = array();
} }
// Parse all the VObjects
foreach($objects as $object) { foreach($objects as $object) {
//OC_Log::write('core','OC_VCategories::rescan: '.substr($object, 0, 100).'(...)', OC_Log::DEBUG); $vobject = OC_VObject::parse($object[1]);
$vobject = OC_VObject::parse($object);
if(!is_null($vobject)) { if(!is_null($vobject)) {
$this->loadFromVObject($vobject, $sync); // Load the categories
$this->loadFromVObject($object[0], $vobject, $sync);
} else { } else {
OC_Log::write('core','OC_VCategories::rescan, unable to parse. ID: '.', '.substr($object, 0, 100).'(...)', OC_Log::DEBUG); OC_Log::write('core', __METHOD__ . ', unable to parse. ID: ' . ', '
. substr($object, 0, 100) . '(...)', OC_Log::DEBUG);
} }
} }
$this->save(); $this->save();
@ -155,15 +326,58 @@ class OC_VCategories {
*/ */
private function save() { private function save() {
if(is_array($this->categories)) { if(is_array($this->categories)) {
usort($this->categories, 'strnatcasecmp'); // usort to also renumber the keys foreach($this->categories as $category) {
$escaped_categories = serialize($this->categories); OCP\DB::insertIfNotExist('*PREFIX*vcategory',
OC_Preferences::setValue($this->user, $this->app, self::PREF_CATEGORIES_LABEL, $escaped_categories); array(
OC_Log::write('core','OC_VCategories::save: '.print_r($this->categories, true), OC_Log::DEBUG); 'uid' => $this->user,
'type' => $this->type,
'category' => $category,
));
}
// reload categories to get the proper ids.
$this->loadCategories();
// Loop through temporarily cached objectid/categoryname pairs
// and save relations.
$categories = $this->categories;
// For some reason this is needed or array_search(i) will return 0..?
ksort($categories);
foreach(self::$relations as $relation) {
$catid = $this->array_searchi($relation['category'], $categories);
OC_Log::write('core', __METHOD__ . 'catid, ' . $relation['category'] . ' ' . $catid, OC_Log::DEBUG);
if($catid) {
OCP\DB::insertIfNotExist('*PREFIX*vcategory_to_object',
array(
'objid' => $relation['objid'],
'categoryid' => $catid,
'type' => $this->type,
));
}
}
self::$relations = array(); // reset
} else { } else {
OC_Log::write('core','OC_VCategories::save: $this->categories is not an array! '.print_r($this->categories, true), OC_Log::ERROR); OC_Log::write('core', __METHOD__.', $this->categories is not an array! '
. print_r($this->categories, true), OC_Log::ERROR);
} }
} }
/**
* @brief Delete category/object relations from the db
* @param $id The id of the object
* @param $type The type of object (event/contact/task/journal).
* Defaults to the type set in the instance
*/
public function purgeObject($id, $type = null) {
$type = is_null($type) ? $this->type : $type;
try {
$stmt = OCP\DB::prepare('DELETE FROM `*PREFIX*vcategory_to_object` '
. 'WHERE `objid` = ? AND `type`= ?');
$stmt->execute(array($id, $type));
} catch(Exception $e) {
OCP\Util::writeLog('core', __METHOD__.', exception: '.$e->getMessage(),
OCP\Util::ERROR);
}
}
/** /**
* @brief Delete categories from the db and from all the vobject supplied * @brief Delete categories from the db and from all the vobject supplied
* @param $names An array of categories to delete * @param $names An array of categories to delete
@ -173,37 +387,65 @@ class OC_VCategories {
if(!is_array($names)) { if(!is_array($names)) {
$names = array($names); $names = array($names);
} }
OC_Log::write('core','OC_VCategories::delete, before: '.print_r($this->categories, true), OC_Log::DEBUG); //OC_Log::write('core', __METHOD__ . ', before: '
// . print_r($this->categories, true), OC_Log::DEBUG);
foreach($names as $name) { foreach($names as $name) {
OC_Log::write('core','OC_VCategories::delete: '.$name, OC_Log::DEBUG); //OC_Log::write('core', __METHOD__.', '.$name, OC_Log::DEBUG);
if($this->hasCategory($name)) { if($this->hasCategory($name)) {
//OC_Log::write('core','OC_VCategories::delete: '.$name.' got it', OC_Log::DEBUG);
unset($this->categories[$this->array_searchi($name, $this->categories)]); unset($this->categories[$this->array_searchi($name, $this->categories)]);
} }
try {
$stmt = OCP\DB::prepare('DELETE FROM `*PREFIX*vcategory` WHERE '
. '`uid` = ? AND `type` = ? AND `category` = ?');
$result = $stmt->execute(array($this->user, $this->type, $name));
} catch(Exception $e) {
OCP\Util::writeLog('core', __METHOD__ . ', exception: '
. $e->getMessage(), OCP\Util::ERROR);
}
} }
$this->save(); //OC_Log::write('core', __METHOD__.', after: '
OC_Log::write('core','OC_VCategories::delete, after: '.print_r($this->categories, true), OC_Log::DEBUG); // . print_r($this->categories, true), OC_Log::DEBUG);
if(!is_null($objects)) { if(!is_null($objects)) {
foreach($objects as $key=>&$value) { foreach($objects as $key=>&$value) {
$vobject = OC_VObject::parse($value[1]); $vobject = OC_VObject::parse($value[1]);
if(!is_null($vobject)) { if(!is_null($vobject)) {
$categories = $vobject->getAsArray('CATEGORIES'); $object = null;
//OC_Log::write('core','OC_VCategories::delete, before: '.$key.': '.print_r($categories, true), OC_Log::DEBUG); $componentname = '';
if (isset($vobject->VEVENT)) {
$object = $vobject->VEVENT;
$componentname = 'VEVENT';
} else
if (isset($vobject->VTODO)) {
$object = $vobject->VTODO;
$componentname = 'VTODO';
} else
if (isset($vobject->VJOURNAL)) {
$object = $vobject->VJOURNAL;
$componentname = 'VJOURNAL';
} else {
$object = $vobject;
}
$categories = $object->getAsArray('CATEGORIES');
foreach($names as $name) { foreach($names as $name) {
$idx = $this->array_searchi($name, $categories); $idx = $this->array_searchi($name, $categories);
//OC_Log::write('core','OC_VCategories::delete, loop: '.$name.', '.print_r($idx, true), OC_Log::DEBUG);
if($idx !== false) { if($idx !== false) {
OC_Log::write('core','OC_VCategories::delete, unsetting: '.$categories[$this->array_searchi($name, $categories)], OC_Log::DEBUG); OC_Log::write('core', __METHOD__
.', unsetting: '
. $categories[$this->array_searchi($name, $categories)],
OC_Log::DEBUG);
unset($categories[$this->array_searchi($name, $categories)]); unset($categories[$this->array_searchi($name, $categories)]);
//unset($categories[$idx]);
} }
} }
//OC_Log::write('core','OC_VCategories::delete, after: '.$key.': '.print_r($categories, true), OC_Log::DEBUG); $object->setString('CATEGORIES', implode(',', $categories));
$vobject->setString('CATEGORIES', implode(',', $categories)); if($vobject !== $object) {
$vobject[$componentname] = $object;
}
$value[1] = $vobject->serialize(); $value[1] = $vobject->serialize();
$objects[$key] = $value; $objects[$key] = $value;
} else { } else {
OC_Log::write('core','OC_VCategories::delete, unable to parse. ID: '.$value[0].', '.substr($value[1], 0, 50).'(...)', OC_Log::DEBUG); OC_Log::write('core', __METHOD__
.', unable to parse. ID: ' . $value[0] . ', '
. substr($value[1], 0, 50) . '(...)', OC_Log::DEBUG);
} }
} }
} }
@ -222,7 +464,10 @@ class OC_VCategories {
if(!is_array($haystack)) { if(!is_array($haystack)) {
return false; return false;
} }
return array_search(strtolower($needle),array_map('strtolower',$haystack)); return array_search(
strtolower($needle),
array_map('strtolower', $haystack)
);
} }
} }