Blame view
sources/apps/activity/lib/usersettings.php
5.11 KB
|
6d9380f96
|
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 |
<?php
/**
* ownCloud - Activity App
*
* @author Joas Schilling
* @copyright 2014 Joas Schilling nickvergessen@owncloud.com
*
* 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 Lesser General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCA\Activity;
use \OCP\Config;
/**
* Class UserSettings
*
* @package OCA\Activity
*/
class UserSettings
{
const EMAIL_SEND_HOURLY = 0;
const EMAIL_SEND_DAILY = 1;
const EMAIL_SEND_WEEKLY = 2;
/**
* Get a setting for a user
*
* Falls back to some good default values if the user does not have a preference
*
* @param string $user
* @param string $method Should be one of 'stream', 'email' or 'setting'
* @param string $type One of the activity types, 'batchtime' or 'self'
* @return mixed
*/
public static function getUserSetting($user, $method, $type) {
return Config::getUserValue(
$user,
'activity',
'notify_' . $method . '_' . $type,
self::getDefaultSetting($method, $type)
);
}
/**
* Get a good default setting for a preference
*
* @param string $method Should be one of 'stream', 'email' or 'setting'
* @param string $type One of the activity types, 'batchtime' or 'self'
* @return bool|int
*/
public static function getDefaultSetting($method, $type) {
if ($method == 'setting') {
if ($type == 'batchtime') {
return 3600;
} else if ($type == 'self') {
return true;
}
}
$settings = self::getDefaultTypes($method);
return in_array($type, $settings);
}
/**
* Get the default selection of types for a method
*
* @param string $method Should be one of 'stream' or 'email'
* @return array Array of strings
*/
public static function getDefaultTypes($method) {
$settings = array();
switch ($method) {
case 'stream':
$settings[] = Data::TYPE_SHARE_CREATED;
$settings[] = Data::TYPE_SHARE_CHANGED;
$settings[] = Data::TYPE_SHARE_DELETED;
// $settings[] = Data::TYPE_SHARE_RESHARED;
//
// $settings[] = Data::TYPE_SHARE_DOWNLOADED;
case 'email':
$settings[] = Data::TYPE_SHARED;
// $settings[] = Data::TYPE_SHARE_EXPIRED;
// $settings[] = Data::TYPE_SHARE_UNSHARED;
//
// $settings[] = Data::TYPE_SHARE_UPLOADED;
//
// $settings[] = Data::TYPE_STORAGE_QUOTA_90;
// $settings[] = Data::TYPE_STORAGE_FAILURE;
}
// Allow other apps to add notification types to the default setting
$additionalSettings = \OC::$server->getActivityManager()->getDefaultTypes($method);
$settings = array_merge($settings, $additionalSettings);
return $settings;
}
/**
* Get a list with enabled notification types for a user
*
* @param string $user Name of the user
* @param string $method Should be one of 'stream' or 'email'
* @return array
*/
public static function getNotificationTypes($user, $method) {
$l = \OC_L10N::get('activity');
$data = new Data(\OC::$server->getActivityManager());
$types = $data->getNotificationTypes($l);
$notificationTypes = array();
foreach ($types as $type => $desc) {
if (self::getUserSetting($user, $method, $type)) {
$notificationTypes[] = $type;
}
}
return $notificationTypes;
}
/**
* Filters the given user array by their notification setting
*
* @param array $users
* @param string $method
* @param string $type
* @return array Returns a "username => b:true" Map for method = stream
* Returns a "username => i:batchtime" Map for method = email
*/
public static function filterUsersBySetting($users, $method, $type) {
if (empty($users) || !is_array($users)) {
return array();
}
$preferences = new \OC\Preferences(\OC_DB::getConnection());
$filteredUsers = array();
$potentialUsers = $preferences->getValueForUsers('activity', 'notify_' . $method . '_' . $type, $users);
foreach ($potentialUsers as $user => $value) {
if ($value) {
$filteredUsers[$user] = true;
}
unset($users[array_search($user, $users)]);
}
// Get the batch time setting from the database
if ($method == 'email') {
$potentialUsers = $preferences->getValueForUsers('activity', 'notify_setting_batchtime', array_keys($filteredUsers));
foreach ($potentialUsers as $user => $value) {
$filteredUsers[$user] = $value;
}
}
if (empty($users)) {
return $filteredUsers;
}
// If the setting is enabled by default,
// we add all users that didn't set the preference yet.
if (UserSettings::getDefaultSetting($method, $type)) {
foreach ($users as $user) {
if ($method == 'stream') {
$filteredUsers[$user] = true;
} else {
$filteredUsers[$user] = self::getDefaultSetting('setting', 'batchtime');
}
}
}
return $filteredUsers;
}
}
|