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
|
<?php
/**
* ownCloud
*
* @author Thomas Tanghus
* @copyright 2012 Thomas Tanghus <thomas@tanghus.net>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
*
* You should have received a copy of the GNU Affero General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
/**
* Class for easy access to categories in VCARD, VEVENT, VTODO and VJOURNAL.
* A Category can be e.g. 'Family', 'Work', 'Chore', 'Special Occation' or anything else
* that is either parsed from a vobject or that the user chooses to add.
* 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 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 {
/**
* Categories
*/
private $categories = array();
private $app = '';
/**
* @brief Constructor.
* @param $app The application identifier e.g. 'contacts' or 'calendar'.
*/
public function __construct($app, $user=null) {
$this->app = $app;
if(is_null($user)) {
$user = OC_User::getUser();
}
$this->categories = OC_VObject::unescapeSemicolons(OC_Preferences::getValue($user, $app, 'extra categories', ''));
}
/**
* @brief Get the categories for a specific.
* @returns array containing the categories as strings.
*/
public function categories() {
return $this->categories;
}
/**
* @brief Checks whether a category is already saved.
* @param $name The name to check for.
* @returns bool
*/
public function hasCategory($name) {
return ($this->in_arrayi($name, $this->categories) == false ? false : true);
}
/**
* @brief Add a new category name.
* @param $names A string with a name or an array of strings containing the name(s) of the categor(y|ies) to add.
* @returns bool Returns false on error.
*/
public function add($names) {
$user = OC_User::getUser();
$newones = array();
if(!is_array($names)) {
$names = array($names);
}
$names = array_map('trim', $names);
foreach($names as $name) {
if(($this->in_arrayi($name, $this->categories) == false) && $name != '') {
$newones[] = $name;
}
}
if(count($newones) > 0) {
$this->categories = $this->cleanArray(array_merge($this->categories, $newones));
OC_Preferences::setValue(OC_User::getUser(), $this->app, 'extra categories', OC_VObject::escapeSemicolons($this->categories));
natcasesort($this->categories); // Dunno if this is necessary
}
return true;
}
/**
* @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.
* @returns bool Returns false if the name already exist (case insensitive) or on error.
*/
public function loadFromVObject($vobject) {
$this->add($vobject->getAsArray('CATEGORIES'));
}
/**
* @brief Delete a category from the db and from all the vobject supplied
* @param $name
* @param $objects An array of arrays with [id,vobject] (as text) pairs suitable for updating the apps object table.
*/
public function delete($name, array &$objects) {
$user = OC_User::getUser();
if(!$this->hasCategory($name)) {
return;
}
unset($this->categories[$this->array_searchi($name, $this->categories)]);
$this->categories = $this->cleanArray($this->categories);
OC_Preferences::setValue($user, $this->app, 'extra categories', OC_VObject::escapeSemicolons($this->categories));
foreach($objects as $key=>&$value) {
$vobject = OC_VObject::parse($value[1]);
if(!is_null($vobject)){
$categories = $vobject->getAsArray('CATEGORIES');
$idx = $this->array_searchi($name, $categories);
if($idx) {
unset($categories[$this->array_searchi($name, $categories)]);
$vobject->setString('CATEGORIES', implode(',', $categories));
$value[1] = $vobject->serialize();
$objects[$key] = $value;
}
} else {
OC_Log::write('core','OC_VCategories::delete, unable to parse. ID: '.$value[0].', '.substr($value[1], 0, 10).'(...)', OC_Log::DEBUG);
}
}
}
// case-insensitive in_array
private function in_arrayi($needle, $haystack) {
return in_array(strtolower($needle), array_map('strtolower', $haystack));
}
// case-insensitive array_search
private function array_searchi($needle, $haystack) {
return array_search(strtolower($needle),array_map('strtolower',$haystack));
}
private function cleanArray($array, $remove_null_number = true){
$new_array = array();
$null_exceptions = array();
foreach ($array as $key => $value){
$value = trim($value);
if($remove_null_number){
$null_exceptions[] = '0';
}
if(!in_array($value, $null_exceptions) && $value != "") {
$new_array[] = $value;
}
}
return $new_array;
}
}
?>
|
