@@ -33,28 +33,28 @@ |
||
33 | 33 | */ |
34 | 34 | interface ISystemTagManagerFactory { |
35 | 35 | |
36 | - /** |
|
37 | - * Constructor for the system tag manager factory |
|
38 | - * |
|
39 | - * @param IServerContainer $serverContainer server container |
|
40 | - * @since 9.0.0 |
|
41 | - */ |
|
42 | - public function __construct(IServerContainer $serverContainer); |
|
36 | + /** |
|
37 | + * Constructor for the system tag manager factory |
|
38 | + * |
|
39 | + * @param IServerContainer $serverContainer server container |
|
40 | + * @since 9.0.0 |
|
41 | + */ |
|
42 | + public function __construct(IServerContainer $serverContainer); |
|
43 | 43 | |
44 | - /** |
|
45 | - * creates and returns an instance of the system tag manager |
|
46 | - * |
|
47 | - * @return ISystemTagManager |
|
48 | - * @since 9.0.0 |
|
49 | - */ |
|
50 | - public function getManager(); |
|
44 | + /** |
|
45 | + * creates and returns an instance of the system tag manager |
|
46 | + * |
|
47 | + * @return ISystemTagManager |
|
48 | + * @since 9.0.0 |
|
49 | + */ |
|
50 | + public function getManager(); |
|
51 | 51 | |
52 | - /** |
|
53 | - * creates and returns an instance of the system tag object |
|
54 | - * mapper |
|
55 | - * |
|
56 | - * @return ISystemTagObjectMapper |
|
57 | - * @since 9.0.0 |
|
58 | - */ |
|
59 | - public function getObjectMapper(); |
|
52 | + /** |
|
53 | + * creates and returns an instance of the system tag object |
|
54 | + * mapper |
|
55 | + * |
|
56 | + * @return ISystemTagObjectMapper |
|
57 | + * @since 9.0.0 |
|
58 | + */ |
|
59 | + public function getObjectMapper(); |
|
60 | 60 | } |
@@ -30,102 +30,102 @@ |
||
30 | 30 | */ |
31 | 31 | interface ISystemTagObjectMapper { |
32 | 32 | |
33 | - /** |
|
34 | - * Get a list of tag ids for the given object ids. |
|
35 | - * |
|
36 | - * This returns an array that maps object id to tag ids |
|
37 | - * [ |
|
38 | - * 1 => array('id1', 'id2'), |
|
39 | - * 2 => array('id3', 'id2'), |
|
40 | - * 3 => array('id5'), |
|
41 | - * 4 => array() |
|
42 | - * ] |
|
43 | - * |
|
44 | - * Untagged objects will have an empty array associated. |
|
45 | - * |
|
46 | - * @param string|array $objIds object ids |
|
47 | - * @param string $objectType object type |
|
48 | - * |
|
49 | - * @return array with object id as key and an array |
|
50 | - * of tag ids as value |
|
51 | - * |
|
52 | - * @since 9.0.0 |
|
53 | - */ |
|
54 | - public function getTagIdsForObjects($objIds, $objectType); |
|
33 | + /** |
|
34 | + * Get a list of tag ids for the given object ids. |
|
35 | + * |
|
36 | + * This returns an array that maps object id to tag ids |
|
37 | + * [ |
|
38 | + * 1 => array('id1', 'id2'), |
|
39 | + * 2 => array('id3', 'id2'), |
|
40 | + * 3 => array('id5'), |
|
41 | + * 4 => array() |
|
42 | + * ] |
|
43 | + * |
|
44 | + * Untagged objects will have an empty array associated. |
|
45 | + * |
|
46 | + * @param string|array $objIds object ids |
|
47 | + * @param string $objectType object type |
|
48 | + * |
|
49 | + * @return array with object id as key and an array |
|
50 | + * of tag ids as value |
|
51 | + * |
|
52 | + * @since 9.0.0 |
|
53 | + */ |
|
54 | + public function getTagIdsForObjects($objIds, $objectType); |
|
55 | 55 | |
56 | - /** |
|
57 | - * Get a list of objects tagged with $tagIds. |
|
58 | - * |
|
59 | - * @param string|array $tagIds Tag id or array of tag ids. |
|
60 | - * @param string $objectType object type |
|
61 | - * @param int $limit Count of object ids you want to get |
|
62 | - * @param string $offset The last object id you already received |
|
63 | - * |
|
64 | - * @return string[] array of object ids or empty array if none found |
|
65 | - * |
|
66 | - * @throws \OCP\SystemTag\TagNotFoundException if at least one of the |
|
67 | - * given tags does not exist |
|
68 | - * @throws \InvalidArgumentException When a limit is specified together with |
|
69 | - * multiple tag ids |
|
70 | - * |
|
71 | - * @since 9.0.0 |
|
72 | - */ |
|
73 | - public function getObjectIdsForTags($tagIds, $objectType, $limit = 0, $offset = ''); |
|
56 | + /** |
|
57 | + * Get a list of objects tagged with $tagIds. |
|
58 | + * |
|
59 | + * @param string|array $tagIds Tag id or array of tag ids. |
|
60 | + * @param string $objectType object type |
|
61 | + * @param int $limit Count of object ids you want to get |
|
62 | + * @param string $offset The last object id you already received |
|
63 | + * |
|
64 | + * @return string[] array of object ids or empty array if none found |
|
65 | + * |
|
66 | + * @throws \OCP\SystemTag\TagNotFoundException if at least one of the |
|
67 | + * given tags does not exist |
|
68 | + * @throws \InvalidArgumentException When a limit is specified together with |
|
69 | + * multiple tag ids |
|
70 | + * |
|
71 | + * @since 9.0.0 |
|
72 | + */ |
|
73 | + public function getObjectIdsForTags($tagIds, $objectType, $limit = 0, $offset = ''); |
|
74 | 74 | |
75 | - /** |
|
76 | - * Assign the given tags to the given object. |
|
77 | - * |
|
78 | - * If at least one of the given tag ids doesn't exist, none of the tags |
|
79 | - * will be assigned. |
|
80 | - * |
|
81 | - * If the relationship already existed, fail silently. |
|
82 | - * |
|
83 | - * @param string $objId object id |
|
84 | - * @param string $objectType object type |
|
85 | - * @param string|array $tagIds tag id or array of tag ids to assign |
|
86 | - * |
|
87 | - * @throws \OCP\SystemTag\TagNotFoundException if at least one of the |
|
88 | - * given tags does not exist |
|
89 | - * |
|
90 | - * @since 9.0.0 |
|
91 | - */ |
|
92 | - public function assignTags($objId, $objectType, $tagIds); |
|
75 | + /** |
|
76 | + * Assign the given tags to the given object. |
|
77 | + * |
|
78 | + * If at least one of the given tag ids doesn't exist, none of the tags |
|
79 | + * will be assigned. |
|
80 | + * |
|
81 | + * If the relationship already existed, fail silently. |
|
82 | + * |
|
83 | + * @param string $objId object id |
|
84 | + * @param string $objectType object type |
|
85 | + * @param string|array $tagIds tag id or array of tag ids to assign |
|
86 | + * |
|
87 | + * @throws \OCP\SystemTag\TagNotFoundException if at least one of the |
|
88 | + * given tags does not exist |
|
89 | + * |
|
90 | + * @since 9.0.0 |
|
91 | + */ |
|
92 | + public function assignTags($objId, $objectType, $tagIds); |
|
93 | 93 | |
94 | - /** |
|
95 | - * Unassign the given tags from the given object. |
|
96 | - * |
|
97 | - * If at least one of the given tag ids doesn't exist, none of the tags |
|
98 | - * will be unassigned. |
|
99 | - * |
|
100 | - * If the relationship did not exist in the first place, fail silently. |
|
101 | - * |
|
102 | - * @param string $objId object id |
|
103 | - * @param string $objectType object type |
|
104 | - * @param string|array $tagIds tag id or array of tag ids to unassign |
|
105 | - * |
|
106 | - * @throws \OCP\SystemTag\TagNotFoundException if at least one of the |
|
107 | - * given tags does not exist |
|
108 | - * |
|
109 | - * @since 9.0.0 |
|
110 | - */ |
|
111 | - public function unassignTags($objId, $objectType, $tagIds); |
|
94 | + /** |
|
95 | + * Unassign the given tags from the given object. |
|
96 | + * |
|
97 | + * If at least one of the given tag ids doesn't exist, none of the tags |
|
98 | + * will be unassigned. |
|
99 | + * |
|
100 | + * If the relationship did not exist in the first place, fail silently. |
|
101 | + * |
|
102 | + * @param string $objId object id |
|
103 | + * @param string $objectType object type |
|
104 | + * @param string|array $tagIds tag id or array of tag ids to unassign |
|
105 | + * |
|
106 | + * @throws \OCP\SystemTag\TagNotFoundException if at least one of the |
|
107 | + * given tags does not exist |
|
108 | + * |
|
109 | + * @since 9.0.0 |
|
110 | + */ |
|
111 | + public function unassignTags($objId, $objectType, $tagIds); |
|
112 | 112 | |
113 | - /** |
|
114 | - * Checks whether the given objects have the given tag. |
|
115 | - * |
|
116 | - * @param string|array $objIds object ids |
|
117 | - * @param string $objectType object type |
|
118 | - * @param string $tagId tag id to check |
|
119 | - * @param bool $all true to check that ALL objects have the tag assigned, |
|
120 | - * false to check that at least ONE object has the tag. |
|
121 | - * |
|
122 | - * @return bool true if the condition set by $all is matched, false |
|
123 | - * otherwise |
|
124 | - * |
|
125 | - * @throws \OCP\SystemTag\TagNotFoundException if the tag does not exist |
|
126 | - * |
|
127 | - * @since 9.0.0 |
|
128 | - */ |
|
129 | - public function haveTag($objIds, $objectType, $tagId, $all = true); |
|
113 | + /** |
|
114 | + * Checks whether the given objects have the given tag. |
|
115 | + * |
|
116 | + * @param string|array $objIds object ids |
|
117 | + * @param string $objectType object type |
|
118 | + * @param string $tagId tag id to check |
|
119 | + * @param bool $all true to check that ALL objects have the tag assigned, |
|
120 | + * false to check that at least ONE object has the tag. |
|
121 | + * |
|
122 | + * @return bool true if the condition set by $all is matched, false |
|
123 | + * otherwise |
|
124 | + * |
|
125 | + * @throws \OCP\SystemTag\TagNotFoundException if the tag does not exist |
|
126 | + * |
|
127 | + * @since 9.0.0 |
|
128 | + */ |
|
129 | + public function haveTag($objIds, $objectType, $tagId, $all = true); |
|
130 | 130 | |
131 | 131 | } |
@@ -32,46 +32,46 @@ |
||
32 | 32 | */ |
33 | 33 | class SystemTagsEntityEvent extends Event { |
34 | 34 | |
35 | - const EVENT_ENTITY = 'OCP\SystemTag\ISystemTagManager::registerEntity'; |
|
35 | + const EVENT_ENTITY = 'OCP\SystemTag\ISystemTagManager::registerEntity'; |
|
36 | 36 | |
37 | - /** @var string */ |
|
38 | - protected $event; |
|
39 | - /** @var \Closure[] */ |
|
40 | - protected $collections; |
|
37 | + /** @var string */ |
|
38 | + protected $event; |
|
39 | + /** @var \Closure[] */ |
|
40 | + protected $collections; |
|
41 | 41 | |
42 | - /** |
|
43 | - * SystemTagsEntityEvent constructor. |
|
44 | - * |
|
45 | - * @param string $event |
|
46 | - * @since 9.1.0 |
|
47 | - */ |
|
48 | - public function __construct($event) { |
|
49 | - $this->event = $event; |
|
50 | - $this->collections = []; |
|
51 | - } |
|
42 | + /** |
|
43 | + * SystemTagsEntityEvent constructor. |
|
44 | + * |
|
45 | + * @param string $event |
|
46 | + * @since 9.1.0 |
|
47 | + */ |
|
48 | + public function __construct($event) { |
|
49 | + $this->event = $event; |
|
50 | + $this->collections = []; |
|
51 | + } |
|
52 | 52 | |
53 | - /** |
|
54 | - * @param string $name |
|
55 | - * @param \Closure $entityExistsFunction The closure should take one |
|
56 | - * argument, which is the id of the entity, that tags |
|
57 | - * should be handled for. The return should then be bool, |
|
58 | - * depending on whether tags are allowed (true) or not. |
|
59 | - * @throws \OutOfBoundsException when the entity name is already taken |
|
60 | - * @since 9.1.0 |
|
61 | - */ |
|
62 | - public function addEntityCollection($name, \Closure $entityExistsFunction) { |
|
63 | - if (isset($this->collections[$name])) { |
|
64 | - throw new \OutOfBoundsException('Duplicate entity name "' . $name . '"'); |
|
65 | - } |
|
53 | + /** |
|
54 | + * @param string $name |
|
55 | + * @param \Closure $entityExistsFunction The closure should take one |
|
56 | + * argument, which is the id of the entity, that tags |
|
57 | + * should be handled for. The return should then be bool, |
|
58 | + * depending on whether tags are allowed (true) or not. |
|
59 | + * @throws \OutOfBoundsException when the entity name is already taken |
|
60 | + * @since 9.1.0 |
|
61 | + */ |
|
62 | + public function addEntityCollection($name, \Closure $entityExistsFunction) { |
|
63 | + if (isset($this->collections[$name])) { |
|
64 | + throw new \OutOfBoundsException('Duplicate entity name "' . $name . '"'); |
|
65 | + } |
|
66 | 66 | |
67 | - $this->collections[$name] = $entityExistsFunction; |
|
68 | - } |
|
67 | + $this->collections[$name] = $entityExistsFunction; |
|
68 | + } |
|
69 | 69 | |
70 | - /** |
|
71 | - * @return \Closure[] |
|
72 | - * @since 9.1.0 |
|
73 | - */ |
|
74 | - public function getEntityCollections() { |
|
75 | - return $this->collections; |
|
76 | - } |
|
70 | + /** |
|
71 | + * @return \Closure[] |
|
72 | + * @since 9.1.0 |
|
73 | + */ |
|
74 | + public function getEntityCollections() { |
|
75 | + return $this->collections; |
|
76 | + } |
|
77 | 77 | } |
@@ -33,133 +33,133 @@ |
||
33 | 33 | */ |
34 | 34 | interface ISystemTagManager { |
35 | 35 | |
36 | - /** |
|
37 | - * Returns the tag objects matching the given tag ids. |
|
38 | - * |
|
39 | - * @param array|string $tagIds id or array of unique ids of the tag to retrieve |
|
40 | - * |
|
41 | - * @return \OCP\SystemTag\ISystemTag[] array of system tags with tag id as key |
|
42 | - * |
|
43 | - * @throws \InvalidArgumentException if at least one given tag ids is invalid (string instead of integer, etc.) |
|
44 | - * @throws \OCP\SystemTag\TagNotFoundException if at least one given tag ids did no exist |
|
45 | - * The message contains a json_encoded array of the ids that could not be found |
|
46 | - * |
|
47 | - * @since 9.0.0 |
|
48 | - */ |
|
49 | - public function getTagsByIds($tagIds); |
|
36 | + /** |
|
37 | + * Returns the tag objects matching the given tag ids. |
|
38 | + * |
|
39 | + * @param array|string $tagIds id or array of unique ids of the tag to retrieve |
|
40 | + * |
|
41 | + * @return \OCP\SystemTag\ISystemTag[] array of system tags with tag id as key |
|
42 | + * |
|
43 | + * @throws \InvalidArgumentException if at least one given tag ids is invalid (string instead of integer, etc.) |
|
44 | + * @throws \OCP\SystemTag\TagNotFoundException if at least one given tag ids did no exist |
|
45 | + * The message contains a json_encoded array of the ids that could not be found |
|
46 | + * |
|
47 | + * @since 9.0.0 |
|
48 | + */ |
|
49 | + public function getTagsByIds($tagIds); |
|
50 | 50 | |
51 | - /** |
|
52 | - * Returns the tag object matching the given attributes. |
|
53 | - * |
|
54 | - * @param string $tagName tag name |
|
55 | - * @param bool $userVisible whether the tag is visible by users |
|
56 | - * @param bool $userAssignable whether the tag is assignable by users |
|
57 | - * |
|
58 | - * @return \OCP\SystemTag\ISystemTag system tag |
|
59 | - * |
|
60 | - * @throws \OCP\SystemTag\TagNotFoundException if tag does not exist |
|
61 | - * |
|
62 | - * @since 9.0.0 |
|
63 | - */ |
|
64 | - public function getTag($tagName, $userVisible, $userAssignable); |
|
51 | + /** |
|
52 | + * Returns the tag object matching the given attributes. |
|
53 | + * |
|
54 | + * @param string $tagName tag name |
|
55 | + * @param bool $userVisible whether the tag is visible by users |
|
56 | + * @param bool $userAssignable whether the tag is assignable by users |
|
57 | + * |
|
58 | + * @return \OCP\SystemTag\ISystemTag system tag |
|
59 | + * |
|
60 | + * @throws \OCP\SystemTag\TagNotFoundException if tag does not exist |
|
61 | + * |
|
62 | + * @since 9.0.0 |
|
63 | + */ |
|
64 | + public function getTag($tagName, $userVisible, $userAssignable); |
|
65 | 65 | |
66 | - /** |
|
67 | - * Creates the tag object using the given attributes. |
|
68 | - * |
|
69 | - * @param string $tagName tag name |
|
70 | - * @param bool $userVisible whether the tag is visible by users |
|
71 | - * @param bool $userAssignable whether the tag is assignable by users |
|
72 | - * |
|
73 | - * @return \OCP\SystemTag\ISystemTag system tag |
|
74 | - * |
|
75 | - * @throws \OCP\SystemTag\TagAlreadyExistsException if tag already exists |
|
76 | - * |
|
77 | - * @since 9.0.0 |
|
78 | - */ |
|
79 | - public function createTag($tagName, $userVisible, $userAssignable); |
|
66 | + /** |
|
67 | + * Creates the tag object using the given attributes. |
|
68 | + * |
|
69 | + * @param string $tagName tag name |
|
70 | + * @param bool $userVisible whether the tag is visible by users |
|
71 | + * @param bool $userAssignable whether the tag is assignable by users |
|
72 | + * |
|
73 | + * @return \OCP\SystemTag\ISystemTag system tag |
|
74 | + * |
|
75 | + * @throws \OCP\SystemTag\TagAlreadyExistsException if tag already exists |
|
76 | + * |
|
77 | + * @since 9.0.0 |
|
78 | + */ |
|
79 | + public function createTag($tagName, $userVisible, $userAssignable); |
|
80 | 80 | |
81 | - /** |
|
82 | - * Returns all known tags, optionally filtered by visibility. |
|
83 | - * |
|
84 | - * @param bool|null $visibilityFilter filter by visibility if non-null |
|
85 | - * @param string $nameSearchPattern optional search pattern for the tag name |
|
86 | - * |
|
87 | - * @return \OCP\SystemTag\ISystemTag[] array of system tags or empty array if none found |
|
88 | - * |
|
89 | - * @since 9.0.0 |
|
90 | - */ |
|
91 | - public function getAllTags($visibilityFilter = null, $nameSearchPattern = null); |
|
81 | + /** |
|
82 | + * Returns all known tags, optionally filtered by visibility. |
|
83 | + * |
|
84 | + * @param bool|null $visibilityFilter filter by visibility if non-null |
|
85 | + * @param string $nameSearchPattern optional search pattern for the tag name |
|
86 | + * |
|
87 | + * @return \OCP\SystemTag\ISystemTag[] array of system tags or empty array if none found |
|
88 | + * |
|
89 | + * @since 9.0.0 |
|
90 | + */ |
|
91 | + public function getAllTags($visibilityFilter = null, $nameSearchPattern = null); |
|
92 | 92 | |
93 | - /** |
|
94 | - * Updates the given tag |
|
95 | - * |
|
96 | - * @param string $tagId tag id |
|
97 | - * @param string $newName the new tag name |
|
98 | - * @param bool $userVisible whether the tag is visible by users |
|
99 | - * @param bool $userAssignable whether the tag is assignable by users |
|
100 | - * |
|
101 | - * @throws \OCP\SystemTag\TagNotFoundException if tag with the given id does not exist |
|
102 | - * @throws \OCP\SystemTag\TagAlreadyExistsException if there is already another tag |
|
103 | - * with the same attributes |
|
104 | - * |
|
105 | - * @since 9.0.0 |
|
106 | - */ |
|
107 | - public function updateTag($tagId, $newName, $userVisible, $userAssignable); |
|
93 | + /** |
|
94 | + * Updates the given tag |
|
95 | + * |
|
96 | + * @param string $tagId tag id |
|
97 | + * @param string $newName the new tag name |
|
98 | + * @param bool $userVisible whether the tag is visible by users |
|
99 | + * @param bool $userAssignable whether the tag is assignable by users |
|
100 | + * |
|
101 | + * @throws \OCP\SystemTag\TagNotFoundException if tag with the given id does not exist |
|
102 | + * @throws \OCP\SystemTag\TagAlreadyExistsException if there is already another tag |
|
103 | + * with the same attributes |
|
104 | + * |
|
105 | + * @since 9.0.0 |
|
106 | + */ |
|
107 | + public function updateTag($tagId, $newName, $userVisible, $userAssignable); |
|
108 | 108 | |
109 | - /** |
|
110 | - * Delete the given tags from the database and all their relationships. |
|
111 | - * |
|
112 | - * @param string|array $tagIds array of tag ids |
|
113 | - * |
|
114 | - * @throws \OCP\SystemTag\TagNotFoundException if at least one tag did not exist |
|
115 | - * |
|
116 | - * @since 9.0.0 |
|
117 | - */ |
|
118 | - public function deleteTags($tagIds); |
|
109 | + /** |
|
110 | + * Delete the given tags from the database and all their relationships. |
|
111 | + * |
|
112 | + * @param string|array $tagIds array of tag ids |
|
113 | + * |
|
114 | + * @throws \OCP\SystemTag\TagNotFoundException if at least one tag did not exist |
|
115 | + * |
|
116 | + * @since 9.0.0 |
|
117 | + */ |
|
118 | + public function deleteTags($tagIds); |
|
119 | 119 | |
120 | - /** |
|
121 | - * Checks whether the given user is allowed to assign/unassign the tag with the |
|
122 | - * given id. |
|
123 | - * |
|
124 | - * @param ISystemTag $tag tag to check permission for |
|
125 | - * @param IUser $user user to check permission for |
|
126 | - * |
|
127 | - * @return true if the user is allowed to assign/unassign the tag, false otherwise |
|
128 | - * |
|
129 | - * @since 9.1.0 |
|
130 | - */ |
|
131 | - public function canUserAssignTag(ISystemTag $tag, IUser $user); |
|
120 | + /** |
|
121 | + * Checks whether the given user is allowed to assign/unassign the tag with the |
|
122 | + * given id. |
|
123 | + * |
|
124 | + * @param ISystemTag $tag tag to check permission for |
|
125 | + * @param IUser $user user to check permission for |
|
126 | + * |
|
127 | + * @return true if the user is allowed to assign/unassign the tag, false otherwise |
|
128 | + * |
|
129 | + * @since 9.1.0 |
|
130 | + */ |
|
131 | + public function canUserAssignTag(ISystemTag $tag, IUser $user); |
|
132 | 132 | |
133 | - /** |
|
134 | - * Checks whether the given user is allowed to see the tag with the given id. |
|
135 | - * |
|
136 | - * @param ISystemTag $tag tag to check permission for |
|
137 | - * @param IUser $user user to check permission for |
|
138 | - * |
|
139 | - * @return true if the user can see the tag, false otherwise |
|
140 | - * |
|
141 | - * @since 9.1.0 |
|
142 | - */ |
|
143 | - public function canUserSeeTag(ISystemTag $tag, IUser $userId); |
|
133 | + /** |
|
134 | + * Checks whether the given user is allowed to see the tag with the given id. |
|
135 | + * |
|
136 | + * @param ISystemTag $tag tag to check permission for |
|
137 | + * @param IUser $user user to check permission for |
|
138 | + * |
|
139 | + * @return true if the user can see the tag, false otherwise |
|
140 | + * |
|
141 | + * @since 9.1.0 |
|
142 | + */ |
|
143 | + public function canUserSeeTag(ISystemTag $tag, IUser $userId); |
|
144 | 144 | |
145 | - /** |
|
146 | - * Set groups that can assign a given tag. |
|
147 | - * |
|
148 | - * @param ISystemTag $tag tag for group assignment |
|
149 | - * @param string[] $groupIds group ids of groups that can assign/unassign the tag |
|
150 | - * |
|
151 | - * @since 9.1.0 |
|
152 | - */ |
|
153 | - public function setTagGroups(ISystemTag $tag, $groupIds); |
|
145 | + /** |
|
146 | + * Set groups that can assign a given tag. |
|
147 | + * |
|
148 | + * @param ISystemTag $tag tag for group assignment |
|
149 | + * @param string[] $groupIds group ids of groups that can assign/unassign the tag |
|
150 | + * |
|
151 | + * @since 9.1.0 |
|
152 | + */ |
|
153 | + public function setTagGroups(ISystemTag $tag, $groupIds); |
|
154 | 154 | |
155 | - /** |
|
156 | - * Get groups that can assign a given tag. |
|
157 | - * |
|
158 | - * @param ISystemTag $tag tag for group assignment |
|
159 | - * |
|
160 | - * @return string[] group ids of groups that can assign/unassign the tag |
|
161 | - * |
|
162 | - * @since 9.1.0 |
|
163 | - */ |
|
164 | - public function getTagGroups(ISystemTag $tag); |
|
155 | + /** |
|
156 | + * Get groups that can assign a given tag. |
|
157 | + * |
|
158 | + * @param ISystemTag $tag tag for group assignment |
|
159 | + * |
|
160 | + * @return string[] group ids of groups that can assign/unassign the tag |
|
161 | + * |
|
162 | + * @since 9.1.0 |
|
163 | + */ |
|
164 | + public function getTagGroups(ISystemTag $tag); |
|
165 | 165 | } |
@@ -28,45 +28,45 @@ |
||
28 | 28 | |
29 | 29 | class Credentials implements ICredentials { |
30 | 30 | |
31 | - /** @var string */ |
|
32 | - private $uid; |
|
31 | + /** @var string */ |
|
32 | + private $uid; |
|
33 | 33 | |
34 | - /** @var string */ |
|
35 | - private $loginName; |
|
34 | + /** @var string */ |
|
35 | + private $loginName; |
|
36 | 36 | |
37 | - /** @var string */ |
|
38 | - private $password; |
|
37 | + /** @var string */ |
|
38 | + private $password; |
|
39 | 39 | |
40 | - /** |
|
41 | - * @param string $uid |
|
42 | - * @param string $loginName |
|
43 | - * @param string $password |
|
44 | - */ |
|
45 | - public function __construct($uid, $loginName, $password) { |
|
46 | - $this->uid = $uid; |
|
47 | - $this->loginName = $loginName; |
|
48 | - $this->password = $password; |
|
49 | - } |
|
40 | + /** |
|
41 | + * @param string $uid |
|
42 | + * @param string $loginName |
|
43 | + * @param string $password |
|
44 | + */ |
|
45 | + public function __construct($uid, $loginName, $password) { |
|
46 | + $this->uid = $uid; |
|
47 | + $this->loginName = $loginName; |
|
48 | + $this->password = $password; |
|
49 | + } |
|
50 | 50 | |
51 | - /** |
|
52 | - * @return string |
|
53 | - */ |
|
54 | - public function getUID() { |
|
55 | - return $this->uid; |
|
56 | - } |
|
51 | + /** |
|
52 | + * @return string |
|
53 | + */ |
|
54 | + public function getUID() { |
|
55 | + return $this->uid; |
|
56 | + } |
|
57 | 57 | |
58 | - /** |
|
59 | - * @return string |
|
60 | - */ |
|
61 | - public function getLoginName() { |
|
62 | - return $this->loginName; |
|
63 | - } |
|
58 | + /** |
|
59 | + * @return string |
|
60 | + */ |
|
61 | + public function getLoginName() { |
|
62 | + return $this->loginName; |
|
63 | + } |
|
64 | 64 | |
65 | - /** |
|
66 | - * @return string |
|
67 | - */ |
|
68 | - public function getPassword() { |
|
69 | - return $this->password; |
|
70 | - } |
|
65 | + /** |
|
66 | + * @return string |
|
67 | + */ |
|
68 | + public function getPassword() { |
|
69 | + return $this->password; |
|
70 | + } |
|
71 | 71 | |
72 | 72 | } |
@@ -37,84 +37,84 @@ |
||
37 | 37 | |
38 | 38 | class Store implements IStore { |
39 | 39 | |
40 | - /** @var ISession */ |
|
41 | - private $session; |
|
42 | - |
|
43 | - /** @var ILogger */ |
|
44 | - private $logger; |
|
45 | - |
|
46 | - /** @var IProvider|null */ |
|
47 | - private $tokenProvider; |
|
48 | - |
|
49 | - /** |
|
50 | - * @param ISession $session |
|
51 | - * @param ILogger $logger |
|
52 | - * @param IProvider $tokenProvider |
|
53 | - */ |
|
54 | - public function __construct(ISession $session, ILogger $logger, IProvider $tokenProvider = null) { |
|
55 | - $this->session = $session; |
|
56 | - $this->logger = $logger; |
|
57 | - $this->tokenProvider = $tokenProvider; |
|
58 | - |
|
59 | - Util::connectHook('OC_User', 'post_login', $this, 'authenticate'); |
|
60 | - } |
|
61 | - |
|
62 | - /** |
|
63 | - * Hook listener on post login |
|
64 | - * |
|
65 | - * @param array $params |
|
66 | - */ |
|
67 | - public function authenticate(array $params) { |
|
68 | - $this->session->set('login_credentials', json_encode($params)); |
|
69 | - } |
|
70 | - |
|
71 | - /** |
|
72 | - * Replace the session implementation |
|
73 | - * |
|
74 | - * @param ISession $session |
|
75 | - */ |
|
76 | - public function setSession(ISession $session) { |
|
77 | - $this->session = $session; |
|
78 | - } |
|
79 | - |
|
80 | - /** |
|
81 | - * @since 12 |
|
82 | - * |
|
83 | - * @return ICredentials the login credentials of the current user |
|
84 | - * @throws CredentialsUnavailableException |
|
85 | - */ |
|
86 | - public function getLoginCredentials() { |
|
87 | - if (is_null($this->tokenProvider)) { |
|
88 | - throw new CredentialsUnavailableException(); |
|
89 | - } |
|
90 | - |
|
91 | - $trySession = false; |
|
92 | - try { |
|
93 | - $sessionId = $this->session->getId(); |
|
94 | - $token = $this->tokenProvider->getToken($sessionId); |
|
95 | - |
|
96 | - $uid = $token->getUID(); |
|
97 | - $user = $token->getLoginName(); |
|
98 | - $password = $this->tokenProvider->getPassword($token, $sessionId); |
|
99 | - |
|
100 | - return new Credentials($uid, $user, $password); |
|
101 | - } catch (SessionNotAvailableException $ex) { |
|
102 | - $this->logger->debug('could not get login credentials because session is unavailable', ['app' => 'core']); |
|
103 | - } catch (InvalidTokenException $ex) { |
|
104 | - $this->logger->debug('could not get login credentials because the token is invalid', ['app' => 'core']); |
|
105 | - $trySession = true; |
|
106 | - } catch (PasswordlessTokenException $ex) { |
|
107 | - $this->logger->debug('could not get login credentials because the token has no password', ['app' => 'core']); |
|
108 | - $trySession = true; |
|
109 | - } |
|
110 | - |
|
111 | - if ($trySession && $this->session->exists('login_credentials')) { |
|
112 | - $creds = json_decode($this->session->get('login_credentials')); |
|
113 | - return new Credentials($creds->uid, $creds->uid, $creds->password); |
|
114 | - } |
|
115 | - |
|
116 | - // If we reach this line, an exception was thrown. |
|
117 | - throw new CredentialsUnavailableException(); |
|
118 | - } |
|
40 | + /** @var ISession */ |
|
41 | + private $session; |
|
42 | + |
|
43 | + /** @var ILogger */ |
|
44 | + private $logger; |
|
45 | + |
|
46 | + /** @var IProvider|null */ |
|
47 | + private $tokenProvider; |
|
48 | + |
|
49 | + /** |
|
50 | + * @param ISession $session |
|
51 | + * @param ILogger $logger |
|
52 | + * @param IProvider $tokenProvider |
|
53 | + */ |
|
54 | + public function __construct(ISession $session, ILogger $logger, IProvider $tokenProvider = null) { |
|
55 | + $this->session = $session; |
|
56 | + $this->logger = $logger; |
|
57 | + $this->tokenProvider = $tokenProvider; |
|
58 | + |
|
59 | + Util::connectHook('OC_User', 'post_login', $this, 'authenticate'); |
|
60 | + } |
|
61 | + |
|
62 | + /** |
|
63 | + * Hook listener on post login |
|
64 | + * |
|
65 | + * @param array $params |
|
66 | + */ |
|
67 | + public function authenticate(array $params) { |
|
68 | + $this->session->set('login_credentials', json_encode($params)); |
|
69 | + } |
|
70 | + |
|
71 | + /** |
|
72 | + * Replace the session implementation |
|
73 | + * |
|
74 | + * @param ISession $session |
|
75 | + */ |
|
76 | + public function setSession(ISession $session) { |
|
77 | + $this->session = $session; |
|
78 | + } |
|
79 | + |
|
80 | + /** |
|
81 | + * @since 12 |
|
82 | + * |
|
83 | + * @return ICredentials the login credentials of the current user |
|
84 | + * @throws CredentialsUnavailableException |
|
85 | + */ |
|
86 | + public function getLoginCredentials() { |
|
87 | + if (is_null($this->tokenProvider)) { |
|
88 | + throw new CredentialsUnavailableException(); |
|
89 | + } |
|
90 | + |
|
91 | + $trySession = false; |
|
92 | + try { |
|
93 | + $sessionId = $this->session->getId(); |
|
94 | + $token = $this->tokenProvider->getToken($sessionId); |
|
95 | + |
|
96 | + $uid = $token->getUID(); |
|
97 | + $user = $token->getLoginName(); |
|
98 | + $password = $this->tokenProvider->getPassword($token, $sessionId); |
|
99 | + |
|
100 | + return new Credentials($uid, $user, $password); |
|
101 | + } catch (SessionNotAvailableException $ex) { |
|
102 | + $this->logger->debug('could not get login credentials because session is unavailable', ['app' => 'core']); |
|
103 | + } catch (InvalidTokenException $ex) { |
|
104 | + $this->logger->debug('could not get login credentials because the token is invalid', ['app' => 'core']); |
|
105 | + $trySession = true; |
|
106 | + } catch (PasswordlessTokenException $ex) { |
|
107 | + $this->logger->debug('could not get login credentials because the token has no password', ['app' => 'core']); |
|
108 | + $trySession = true; |
|
109 | + } |
|
110 | + |
|
111 | + if ($trySession && $this->session->exists('login_credentials')) { |
|
112 | + $creds = json_decode($this->session->get('login_credentials')); |
|
113 | + return new Credentials($creds->uid, $creds->uid, $creds->password); |
|
114 | + } |
|
115 | + |
|
116 | + // If we reach this line, an exception was thrown. |
|
117 | + throw new CredentialsUnavailableException(); |
|
118 | + } |
|
119 | 119 | |
120 | 120 | } |
@@ -37,232 +37,232 @@ |
||
37 | 37 | |
38 | 38 | class Manager { |
39 | 39 | |
40 | - const SESSION_UID_KEY = 'two_factor_auth_uid'; |
|
41 | - const BACKUP_CODES_APP_ID = 'twofactor_backupcodes'; |
|
42 | - const BACKUP_CODES_PROVIDER_ID = 'backup_codes'; |
|
43 | - const REMEMBER_LOGIN = 'two_factor_remember_login'; |
|
40 | + const SESSION_UID_KEY = 'two_factor_auth_uid'; |
|
41 | + const BACKUP_CODES_APP_ID = 'twofactor_backupcodes'; |
|
42 | + const BACKUP_CODES_PROVIDER_ID = 'backup_codes'; |
|
43 | + const REMEMBER_LOGIN = 'two_factor_remember_login'; |
|
44 | 44 | |
45 | - /** @var AppManager */ |
|
46 | - private $appManager; |
|
45 | + /** @var AppManager */ |
|
46 | + private $appManager; |
|
47 | 47 | |
48 | - /** @var ISession */ |
|
49 | - private $session; |
|
48 | + /** @var ISession */ |
|
49 | + private $session; |
|
50 | 50 | |
51 | - /** @var IConfig */ |
|
52 | - private $config; |
|
51 | + /** @var IConfig */ |
|
52 | + private $config; |
|
53 | 53 | |
54 | - /** @var IManager */ |
|
55 | - private $activityManager; |
|
54 | + /** @var IManager */ |
|
55 | + private $activityManager; |
|
56 | 56 | |
57 | - /** @var ILogger */ |
|
58 | - private $logger; |
|
57 | + /** @var ILogger */ |
|
58 | + private $logger; |
|
59 | 59 | |
60 | - /** |
|
61 | - * @param AppManager $appManager |
|
62 | - * @param ISession $session |
|
63 | - * @param IConfig $config |
|
64 | - * @param IManager $activityManager |
|
65 | - * @param ILogger $logger |
|
66 | - */ |
|
67 | - public function __construct(AppManager $appManager, ISession $session, IConfig $config, IManager $activityManager, |
|
68 | - ILogger $logger) { |
|
69 | - $this->appManager = $appManager; |
|
70 | - $this->session = $session; |
|
71 | - $this->config = $config; |
|
72 | - $this->activityManager = $activityManager; |
|
73 | - $this->logger = $logger; |
|
74 | - } |
|
60 | + /** |
|
61 | + * @param AppManager $appManager |
|
62 | + * @param ISession $session |
|
63 | + * @param IConfig $config |
|
64 | + * @param IManager $activityManager |
|
65 | + * @param ILogger $logger |
|
66 | + */ |
|
67 | + public function __construct(AppManager $appManager, ISession $session, IConfig $config, IManager $activityManager, |
|
68 | + ILogger $logger) { |
|
69 | + $this->appManager = $appManager; |
|
70 | + $this->session = $session; |
|
71 | + $this->config = $config; |
|
72 | + $this->activityManager = $activityManager; |
|
73 | + $this->logger = $logger; |
|
74 | + } |
|
75 | 75 | |
76 | - /** |
|
77 | - * Determine whether the user must provide a second factor challenge |
|
78 | - * |
|
79 | - * @param IUser $user |
|
80 | - * @return boolean |
|
81 | - */ |
|
82 | - public function isTwoFactorAuthenticated(IUser $user) { |
|
83 | - $twoFactorEnabled = ((int) $this->config->getUserValue($user->getUID(), 'core', 'two_factor_auth_disabled', 0)) === 0; |
|
84 | - return $twoFactorEnabled && count($this->getProviders($user)) > 0; |
|
85 | - } |
|
76 | + /** |
|
77 | + * Determine whether the user must provide a second factor challenge |
|
78 | + * |
|
79 | + * @param IUser $user |
|
80 | + * @return boolean |
|
81 | + */ |
|
82 | + public function isTwoFactorAuthenticated(IUser $user) { |
|
83 | + $twoFactorEnabled = ((int) $this->config->getUserValue($user->getUID(), 'core', 'two_factor_auth_disabled', 0)) === 0; |
|
84 | + return $twoFactorEnabled && count($this->getProviders($user)) > 0; |
|
85 | + } |
|
86 | 86 | |
87 | - /** |
|
88 | - * Disable 2FA checks for the given user |
|
89 | - * |
|
90 | - * @param IUser $user |
|
91 | - */ |
|
92 | - public function disableTwoFactorAuthentication(IUser $user) { |
|
93 | - $this->config->setUserValue($user->getUID(), 'core', 'two_factor_auth_disabled', 1); |
|
94 | - } |
|
87 | + /** |
|
88 | + * Disable 2FA checks for the given user |
|
89 | + * |
|
90 | + * @param IUser $user |
|
91 | + */ |
|
92 | + public function disableTwoFactorAuthentication(IUser $user) { |
|
93 | + $this->config->setUserValue($user->getUID(), 'core', 'two_factor_auth_disabled', 1); |
|
94 | + } |
|
95 | 95 | |
96 | - /** |
|
97 | - * Enable all 2FA checks for the given user |
|
98 | - * |
|
99 | - * @param IUser $user |
|
100 | - */ |
|
101 | - public function enableTwoFactorAuthentication(IUser $user) { |
|
102 | - $this->config->deleteUserValue($user->getUID(), 'core', 'two_factor_auth_disabled'); |
|
103 | - } |
|
96 | + /** |
|
97 | + * Enable all 2FA checks for the given user |
|
98 | + * |
|
99 | + * @param IUser $user |
|
100 | + */ |
|
101 | + public function enableTwoFactorAuthentication(IUser $user) { |
|
102 | + $this->config->deleteUserValue($user->getUID(), 'core', 'two_factor_auth_disabled'); |
|
103 | + } |
|
104 | 104 | |
105 | - /** |
|
106 | - * Get a 2FA provider by its ID |
|
107 | - * |
|
108 | - * @param IUser $user |
|
109 | - * @param string $challengeProviderId |
|
110 | - * @return IProvider|null |
|
111 | - */ |
|
112 | - public function getProvider(IUser $user, $challengeProviderId) { |
|
113 | - $providers = $this->getProviders($user, true); |
|
114 | - return isset($providers[$challengeProviderId]) ? $providers[$challengeProviderId] : null; |
|
115 | - } |
|
105 | + /** |
|
106 | + * Get a 2FA provider by its ID |
|
107 | + * |
|
108 | + * @param IUser $user |
|
109 | + * @param string $challengeProviderId |
|
110 | + * @return IProvider|null |
|
111 | + */ |
|
112 | + public function getProvider(IUser $user, $challengeProviderId) { |
|
113 | + $providers = $this->getProviders($user, true); |
|
114 | + return isset($providers[$challengeProviderId]) ? $providers[$challengeProviderId] : null; |
|
115 | + } |
|
116 | 116 | |
117 | - /** |
|
118 | - * @param IUser $user |
|
119 | - * @return IProvider|null the backup provider, if enabled for the given user |
|
120 | - */ |
|
121 | - public function getBackupProvider(IUser $user) { |
|
122 | - $providers = $this->getProviders($user, true); |
|
123 | - if (!isset($providers[self::BACKUP_CODES_PROVIDER_ID])) { |
|
124 | - return null; |
|
125 | - } |
|
126 | - return $providers[self::BACKUP_CODES_PROVIDER_ID]; |
|
127 | - } |
|
117 | + /** |
|
118 | + * @param IUser $user |
|
119 | + * @return IProvider|null the backup provider, if enabled for the given user |
|
120 | + */ |
|
121 | + public function getBackupProvider(IUser $user) { |
|
122 | + $providers = $this->getProviders($user, true); |
|
123 | + if (!isset($providers[self::BACKUP_CODES_PROVIDER_ID])) { |
|
124 | + return null; |
|
125 | + } |
|
126 | + return $providers[self::BACKUP_CODES_PROVIDER_ID]; |
|
127 | + } |
|
128 | 128 | |
129 | - /** |
|
130 | - * Get the list of 2FA providers for the given user |
|
131 | - * |
|
132 | - * @param IUser $user |
|
133 | - * @param bool $includeBackupApp |
|
134 | - * @return IProvider[] |
|
135 | - * @throws Exception |
|
136 | - */ |
|
137 | - public function getProviders(IUser $user, $includeBackupApp = false) { |
|
138 | - $allApps = $this->appManager->getEnabledAppsForUser($user); |
|
139 | - $providers = []; |
|
129 | + /** |
|
130 | + * Get the list of 2FA providers for the given user |
|
131 | + * |
|
132 | + * @param IUser $user |
|
133 | + * @param bool $includeBackupApp |
|
134 | + * @return IProvider[] |
|
135 | + * @throws Exception |
|
136 | + */ |
|
137 | + public function getProviders(IUser $user, $includeBackupApp = false) { |
|
138 | + $allApps = $this->appManager->getEnabledAppsForUser($user); |
|
139 | + $providers = []; |
|
140 | 140 | |
141 | - foreach ($allApps as $appId) { |
|
142 | - if (!$includeBackupApp && $appId === self::BACKUP_CODES_APP_ID) { |
|
143 | - continue; |
|
144 | - } |
|
141 | + foreach ($allApps as $appId) { |
|
142 | + if (!$includeBackupApp && $appId === self::BACKUP_CODES_APP_ID) { |
|
143 | + continue; |
|
144 | + } |
|
145 | 145 | |
146 | - $info = $this->appManager->getAppInfo($appId); |
|
147 | - if (isset($info['two-factor-providers'])) { |
|
148 | - $providerClasses = $info['two-factor-providers']; |
|
149 | - foreach ($providerClasses as $class) { |
|
150 | - try { |
|
151 | - $this->loadTwoFactorApp($appId); |
|
152 | - $provider = OC::$server->query($class); |
|
153 | - $providers[$provider->getId()] = $provider; |
|
154 | - } catch (QueryException $exc) { |
|
155 | - // Provider class can not be resolved |
|
156 | - throw new Exception("Could not load two-factor auth provider $class"); |
|
157 | - } |
|
158 | - } |
|
159 | - } |
|
160 | - } |
|
146 | + $info = $this->appManager->getAppInfo($appId); |
|
147 | + if (isset($info['two-factor-providers'])) { |
|
148 | + $providerClasses = $info['two-factor-providers']; |
|
149 | + foreach ($providerClasses as $class) { |
|
150 | + try { |
|
151 | + $this->loadTwoFactorApp($appId); |
|
152 | + $provider = OC::$server->query($class); |
|
153 | + $providers[$provider->getId()] = $provider; |
|
154 | + } catch (QueryException $exc) { |
|
155 | + // Provider class can not be resolved |
|
156 | + throw new Exception("Could not load two-factor auth provider $class"); |
|
157 | + } |
|
158 | + } |
|
159 | + } |
|
160 | + } |
|
161 | 161 | |
162 | - return array_filter($providers, function ($provider) use ($user) { |
|
163 | - /* @var $provider IProvider */ |
|
164 | - return $provider->isTwoFactorAuthEnabledForUser($user); |
|
165 | - }); |
|
166 | - } |
|
162 | + return array_filter($providers, function ($provider) use ($user) { |
|
163 | + /* @var $provider IProvider */ |
|
164 | + return $provider->isTwoFactorAuthEnabledForUser($user); |
|
165 | + }); |
|
166 | + } |
|
167 | 167 | |
168 | - /** |
|
169 | - * Load an app by ID if it has not been loaded yet |
|
170 | - * |
|
171 | - * @param string $appId |
|
172 | - */ |
|
173 | - protected function loadTwoFactorApp($appId) { |
|
174 | - if (!OC_App::isAppLoaded($appId)) { |
|
175 | - OC_App::loadApp($appId); |
|
176 | - } |
|
177 | - } |
|
168 | + /** |
|
169 | + * Load an app by ID if it has not been loaded yet |
|
170 | + * |
|
171 | + * @param string $appId |
|
172 | + */ |
|
173 | + protected function loadTwoFactorApp($appId) { |
|
174 | + if (!OC_App::isAppLoaded($appId)) { |
|
175 | + OC_App::loadApp($appId); |
|
176 | + } |
|
177 | + } |
|
178 | 178 | |
179 | - /** |
|
180 | - * Verify the given challenge |
|
181 | - * |
|
182 | - * @param string $providerId |
|
183 | - * @param IUser $user |
|
184 | - * @param string $challenge |
|
185 | - * @return boolean |
|
186 | - */ |
|
187 | - public function verifyChallenge($providerId, IUser $user, $challenge) { |
|
188 | - $provider = $this->getProvider($user, $providerId); |
|
189 | - if (is_null($provider)) { |
|
190 | - return false; |
|
191 | - } |
|
179 | + /** |
|
180 | + * Verify the given challenge |
|
181 | + * |
|
182 | + * @param string $providerId |
|
183 | + * @param IUser $user |
|
184 | + * @param string $challenge |
|
185 | + * @return boolean |
|
186 | + */ |
|
187 | + public function verifyChallenge($providerId, IUser $user, $challenge) { |
|
188 | + $provider = $this->getProvider($user, $providerId); |
|
189 | + if (is_null($provider)) { |
|
190 | + return false; |
|
191 | + } |
|
192 | 192 | |
193 | - $passed = $provider->verifyChallenge($user, $challenge); |
|
194 | - if ($passed) { |
|
195 | - if ($this->session->get(self::REMEMBER_LOGIN) === true) { |
|
196 | - // TODO: resolve cyclic dependency and use DI |
|
197 | - \OC::$server->getUserSession()->createRememberMeToken($user); |
|
198 | - } |
|
199 | - $this->session->remove(self::SESSION_UID_KEY); |
|
200 | - $this->session->remove(self::REMEMBER_LOGIN); |
|
193 | + $passed = $provider->verifyChallenge($user, $challenge); |
|
194 | + if ($passed) { |
|
195 | + if ($this->session->get(self::REMEMBER_LOGIN) === true) { |
|
196 | + // TODO: resolve cyclic dependency and use DI |
|
197 | + \OC::$server->getUserSession()->createRememberMeToken($user); |
|
198 | + } |
|
199 | + $this->session->remove(self::SESSION_UID_KEY); |
|
200 | + $this->session->remove(self::REMEMBER_LOGIN); |
|
201 | 201 | |
202 | - $this->publishEvent($user, 'twofactor_success', [ |
|
203 | - 'provider' => $provider->getDisplayName(), |
|
204 | - ]); |
|
205 | - } else { |
|
206 | - $this->publishEvent($user, 'twofactor_failed', [ |
|
207 | - 'provider' => $provider->getDisplayName(), |
|
208 | - ]); |
|
209 | - } |
|
210 | - return $passed; |
|
211 | - } |
|
202 | + $this->publishEvent($user, 'twofactor_success', [ |
|
203 | + 'provider' => $provider->getDisplayName(), |
|
204 | + ]); |
|
205 | + } else { |
|
206 | + $this->publishEvent($user, 'twofactor_failed', [ |
|
207 | + 'provider' => $provider->getDisplayName(), |
|
208 | + ]); |
|
209 | + } |
|
210 | + return $passed; |
|
211 | + } |
|
212 | 212 | |
213 | - /** |
|
214 | - * Push a 2fa event the user's activity stream |
|
215 | - * |
|
216 | - * @param IUser $user |
|
217 | - * @param string $event |
|
218 | - */ |
|
219 | - private function publishEvent(IUser $user, $event, array $params) { |
|
220 | - $activity = $this->activityManager->generateEvent(); |
|
221 | - $activity->setApp('twofactor_generic') |
|
222 | - ->setType('twofactor') |
|
223 | - ->setAuthor($user->getUID()) |
|
224 | - ->setAffectedUser($user->getUID()) |
|
225 | - ->setSubject($event, $params); |
|
226 | - try { |
|
227 | - $this->activityManager->publish($activity); |
|
228 | - } catch (Exception $e) { |
|
229 | - $this->logger->warning('could not publish backup code creation activity', ['app' => 'twofactor_backupcodes']); |
|
230 | - $this->logger->logException($e, ['app' => 'twofactor_backupcodes']); |
|
231 | - } |
|
232 | - } |
|
213 | + /** |
|
214 | + * Push a 2fa event the user's activity stream |
|
215 | + * |
|
216 | + * @param IUser $user |
|
217 | + * @param string $event |
|
218 | + */ |
|
219 | + private function publishEvent(IUser $user, $event, array $params) { |
|
220 | + $activity = $this->activityManager->generateEvent(); |
|
221 | + $activity->setApp('twofactor_generic') |
|
222 | + ->setType('twofactor') |
|
223 | + ->setAuthor($user->getUID()) |
|
224 | + ->setAffectedUser($user->getUID()) |
|
225 | + ->setSubject($event, $params); |
|
226 | + try { |
|
227 | + $this->activityManager->publish($activity); |
|
228 | + } catch (Exception $e) { |
|
229 | + $this->logger->warning('could not publish backup code creation activity', ['app' => 'twofactor_backupcodes']); |
|
230 | + $this->logger->logException($e, ['app' => 'twofactor_backupcodes']); |
|
231 | + } |
|
232 | + } |
|
233 | 233 | |
234 | - /** |
|
235 | - * Check if the currently logged in user needs to pass 2FA |
|
236 | - * |
|
237 | - * @param IUser $user the currently logged in user |
|
238 | - * @return boolean |
|
239 | - */ |
|
240 | - public function needsSecondFactor(IUser $user = null) { |
|
241 | - if (is_null($user) || !$this->session->exists(self::SESSION_UID_KEY)) { |
|
242 | - return false; |
|
243 | - } |
|
234 | + /** |
|
235 | + * Check if the currently logged in user needs to pass 2FA |
|
236 | + * |
|
237 | + * @param IUser $user the currently logged in user |
|
238 | + * @return boolean |
|
239 | + */ |
|
240 | + public function needsSecondFactor(IUser $user = null) { |
|
241 | + if (is_null($user) || !$this->session->exists(self::SESSION_UID_KEY)) { |
|
242 | + return false; |
|
243 | + } |
|
244 | 244 | |
245 | - if (!$this->isTwoFactorAuthenticated($user)) { |
|
246 | - // There is no second factor any more -> let the user pass |
|
247 | - // This prevents infinite redirect loops when a user is about |
|
248 | - // to solve the 2FA challenge, and the provider app is |
|
249 | - // disabled the same time |
|
250 | - $this->session->remove(self::SESSION_UID_KEY); |
|
251 | - return false; |
|
252 | - } |
|
245 | + if (!$this->isTwoFactorAuthenticated($user)) { |
|
246 | + // There is no second factor any more -> let the user pass |
|
247 | + // This prevents infinite redirect loops when a user is about |
|
248 | + // to solve the 2FA challenge, and the provider app is |
|
249 | + // disabled the same time |
|
250 | + $this->session->remove(self::SESSION_UID_KEY); |
|
251 | + return false; |
|
252 | + } |
|
253 | 253 | |
254 | - return true; |
|
255 | - } |
|
254 | + return true; |
|
255 | + } |
|
256 | 256 | |
257 | - /** |
|
258 | - * Prepare the 2FA login |
|
259 | - * |
|
260 | - * @param IUser $user |
|
261 | - * @param boolean $rememberMe |
|
262 | - */ |
|
263 | - public function prepareTwoFactorLogin(IUser $user, $rememberMe) { |
|
264 | - $this->session->set(self::SESSION_UID_KEY, $user->getUID()); |
|
265 | - $this->session->set(self::REMEMBER_LOGIN, $rememberMe); |
|
266 | - } |
|
257 | + /** |
|
258 | + * Prepare the 2FA login |
|
259 | + * |
|
260 | + * @param IUser $user |
|
261 | + * @param boolean $rememberMe |
|
262 | + */ |
|
263 | + public function prepareTwoFactorLogin(IUser $user, $rememberMe) { |
|
264 | + $this->session->set(self::SESSION_UID_KEY, $user->getUID()); |
|
265 | + $this->session->set(self::REMEMBER_LOGIN, $rememberMe); |
|
266 | + } |
|
267 | 267 | |
268 | 268 | } |
@@ -30,123 +30,123 @@ |
||
30 | 30 | |
31 | 31 | class DefaultTokenMapper extends Mapper { |
32 | 32 | |
33 | - public function __construct(IDBConnection $db) { |
|
34 | - parent::__construct($db, 'authtoken'); |
|
35 | - } |
|
33 | + public function __construct(IDBConnection $db) { |
|
34 | + parent::__construct($db, 'authtoken'); |
|
35 | + } |
|
36 | 36 | |
37 | - /** |
|
38 | - * Invalidate (delete) a given token |
|
39 | - * |
|
40 | - * @param string $token |
|
41 | - */ |
|
42 | - public function invalidate($token) { |
|
43 | - /* @var $qb IQueryBuilder */ |
|
44 | - $qb = $this->db->getQueryBuilder(); |
|
45 | - $qb->delete('authtoken') |
|
46 | - ->where($qb->expr()->eq('token', $qb->createParameter('token'))) |
|
47 | - ->setParameter('token', $token) |
|
48 | - ->execute(); |
|
49 | - } |
|
37 | + /** |
|
38 | + * Invalidate (delete) a given token |
|
39 | + * |
|
40 | + * @param string $token |
|
41 | + */ |
|
42 | + public function invalidate($token) { |
|
43 | + /* @var $qb IQueryBuilder */ |
|
44 | + $qb = $this->db->getQueryBuilder(); |
|
45 | + $qb->delete('authtoken') |
|
46 | + ->where($qb->expr()->eq('token', $qb->createParameter('token'))) |
|
47 | + ->setParameter('token', $token) |
|
48 | + ->execute(); |
|
49 | + } |
|
50 | 50 | |
51 | - /** |
|
52 | - * @param int $olderThan |
|
53 | - * @param int $remember |
|
54 | - */ |
|
55 | - public function invalidateOld($olderThan, $remember = IToken::DO_NOT_REMEMBER) { |
|
56 | - /* @var $qb IQueryBuilder */ |
|
57 | - $qb = $this->db->getQueryBuilder(); |
|
58 | - $qb->delete('authtoken') |
|
59 | - ->where($qb->expr()->lt('last_activity', $qb->createNamedParameter($olderThan, IQueryBuilder::PARAM_INT))) |
|
60 | - ->andWhere($qb->expr()->eq('type', $qb->createNamedParameter(IToken::TEMPORARY_TOKEN, IQueryBuilder::PARAM_INT))) |
|
61 | - ->andWhere($qb->expr()->eq('remember', $qb->createNamedParameter($remember, IQueryBuilder::PARAM_INT))) |
|
62 | - ->execute(); |
|
63 | - } |
|
51 | + /** |
|
52 | + * @param int $olderThan |
|
53 | + * @param int $remember |
|
54 | + */ |
|
55 | + public function invalidateOld($olderThan, $remember = IToken::DO_NOT_REMEMBER) { |
|
56 | + /* @var $qb IQueryBuilder */ |
|
57 | + $qb = $this->db->getQueryBuilder(); |
|
58 | + $qb->delete('authtoken') |
|
59 | + ->where($qb->expr()->lt('last_activity', $qb->createNamedParameter($olderThan, IQueryBuilder::PARAM_INT))) |
|
60 | + ->andWhere($qb->expr()->eq('type', $qb->createNamedParameter(IToken::TEMPORARY_TOKEN, IQueryBuilder::PARAM_INT))) |
|
61 | + ->andWhere($qb->expr()->eq('remember', $qb->createNamedParameter($remember, IQueryBuilder::PARAM_INT))) |
|
62 | + ->execute(); |
|
63 | + } |
|
64 | 64 | |
65 | - /** |
|
66 | - * Get the user UID for the given token |
|
67 | - * |
|
68 | - * @param string $token |
|
69 | - * @throws DoesNotExistException |
|
70 | - * @return DefaultToken |
|
71 | - */ |
|
72 | - public function getToken($token) { |
|
73 | - /* @var $qb IQueryBuilder */ |
|
74 | - $qb = $this->db->getQueryBuilder(); |
|
75 | - $result = $qb->select('id', 'uid', 'login_name', 'password', 'name', 'type', 'remember', 'token', 'last_activity', 'last_check', 'scope') |
|
76 | - ->from('authtoken') |
|
77 | - ->where($qb->expr()->eq('token', $qb->createNamedParameter($token))) |
|
78 | - ->execute(); |
|
65 | + /** |
|
66 | + * Get the user UID for the given token |
|
67 | + * |
|
68 | + * @param string $token |
|
69 | + * @throws DoesNotExistException |
|
70 | + * @return DefaultToken |
|
71 | + */ |
|
72 | + public function getToken($token) { |
|
73 | + /* @var $qb IQueryBuilder */ |
|
74 | + $qb = $this->db->getQueryBuilder(); |
|
75 | + $result = $qb->select('id', 'uid', 'login_name', 'password', 'name', 'type', 'remember', 'token', 'last_activity', 'last_check', 'scope') |
|
76 | + ->from('authtoken') |
|
77 | + ->where($qb->expr()->eq('token', $qb->createNamedParameter($token))) |
|
78 | + ->execute(); |
|
79 | 79 | |
80 | - $data = $result->fetch(); |
|
81 | - $result->closeCursor(); |
|
82 | - if ($data === false) { |
|
83 | - throw new DoesNotExistException('token does not exist'); |
|
84 | - } |
|
80 | + $data = $result->fetch(); |
|
81 | + $result->closeCursor(); |
|
82 | + if ($data === false) { |
|
83 | + throw new DoesNotExistException('token does not exist'); |
|
84 | + } |
|
85 | 85 | ; |
86 | - return DefaultToken::fromRow($data); |
|
87 | - } |
|
86 | + return DefaultToken::fromRow($data); |
|
87 | + } |
|
88 | 88 | |
89 | - /** |
|
90 | - * Get the token for $id |
|
91 | - * |
|
92 | - * @param string $id |
|
93 | - * @throws DoesNotExistException |
|
94 | - * @return DefaultToken |
|
95 | - */ |
|
96 | - public function getTokenById($id) { |
|
97 | - /* @var $qb IQueryBuilder */ |
|
98 | - $qb = $this->db->getQueryBuilder(); |
|
99 | - $result = $qb->select('id', 'uid', 'login_name', 'password', 'name', 'type', 'token', 'last_activity', 'last_check', 'scope') |
|
100 | - ->from('authtoken') |
|
101 | - ->where($qb->expr()->eq('id', $qb->createNamedParameter($id))) |
|
102 | - ->execute(); |
|
89 | + /** |
|
90 | + * Get the token for $id |
|
91 | + * |
|
92 | + * @param string $id |
|
93 | + * @throws DoesNotExistException |
|
94 | + * @return DefaultToken |
|
95 | + */ |
|
96 | + public function getTokenById($id) { |
|
97 | + /* @var $qb IQueryBuilder */ |
|
98 | + $qb = $this->db->getQueryBuilder(); |
|
99 | + $result = $qb->select('id', 'uid', 'login_name', 'password', 'name', 'type', 'token', 'last_activity', 'last_check', 'scope') |
|
100 | + ->from('authtoken') |
|
101 | + ->where($qb->expr()->eq('id', $qb->createNamedParameter($id))) |
|
102 | + ->execute(); |
|
103 | 103 | |
104 | - $data = $result->fetch(); |
|
105 | - $result->closeCursor(); |
|
106 | - if ($data === false) { |
|
107 | - throw new DoesNotExistException('token does not exist'); |
|
108 | - }; |
|
109 | - return DefaultToken::fromRow($data); |
|
110 | - } |
|
104 | + $data = $result->fetch(); |
|
105 | + $result->closeCursor(); |
|
106 | + if ($data === false) { |
|
107 | + throw new DoesNotExistException('token does not exist'); |
|
108 | + }; |
|
109 | + return DefaultToken::fromRow($data); |
|
110 | + } |
|
111 | 111 | |
112 | - /** |
|
113 | - * Get all token of a user |
|
114 | - * |
|
115 | - * The provider may limit the number of result rows in case of an abuse |
|
116 | - * where a high number of (session) tokens is generated |
|
117 | - * |
|
118 | - * @param IUser $user |
|
119 | - * @return DefaultToken[] |
|
120 | - */ |
|
121 | - public function getTokenByUser(IUser $user) { |
|
122 | - /* @var $qb IQueryBuilder */ |
|
123 | - $qb = $this->db->getQueryBuilder(); |
|
124 | - $qb->select('id', 'uid', 'login_name', 'password', 'name', 'type', 'remember', 'token', 'last_activity', 'last_check', 'scope') |
|
125 | - ->from('authtoken') |
|
126 | - ->where($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID()))) |
|
127 | - ->setMaxResults(1000); |
|
128 | - $result = $qb->execute(); |
|
129 | - $data = $result->fetchAll(); |
|
130 | - $result->closeCursor(); |
|
112 | + /** |
|
113 | + * Get all token of a user |
|
114 | + * |
|
115 | + * The provider may limit the number of result rows in case of an abuse |
|
116 | + * where a high number of (session) tokens is generated |
|
117 | + * |
|
118 | + * @param IUser $user |
|
119 | + * @return DefaultToken[] |
|
120 | + */ |
|
121 | + public function getTokenByUser(IUser $user) { |
|
122 | + /* @var $qb IQueryBuilder */ |
|
123 | + $qb = $this->db->getQueryBuilder(); |
|
124 | + $qb->select('id', 'uid', 'login_name', 'password', 'name', 'type', 'remember', 'token', 'last_activity', 'last_check', 'scope') |
|
125 | + ->from('authtoken') |
|
126 | + ->where($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID()))) |
|
127 | + ->setMaxResults(1000); |
|
128 | + $result = $qb->execute(); |
|
129 | + $data = $result->fetchAll(); |
|
130 | + $result->closeCursor(); |
|
131 | 131 | |
132 | - $entities = array_map(function ($row) { |
|
133 | - return DefaultToken::fromRow($row); |
|
134 | - }, $data); |
|
132 | + $entities = array_map(function ($row) { |
|
133 | + return DefaultToken::fromRow($row); |
|
134 | + }, $data); |
|
135 | 135 | |
136 | - return $entities; |
|
137 | - } |
|
136 | + return $entities; |
|
137 | + } |
|
138 | 138 | |
139 | - /** |
|
140 | - * @param IUser $user |
|
141 | - * @param int $id |
|
142 | - */ |
|
143 | - public function deleteById(IUser $user, $id) { |
|
144 | - /* @var $qb IQueryBuilder */ |
|
145 | - $qb = $this->db->getQueryBuilder(); |
|
146 | - $qb->delete('authtoken') |
|
147 | - ->where($qb->expr()->eq('id', $qb->createNamedParameter($id))) |
|
148 | - ->andWhere($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID()))); |
|
149 | - $qb->execute(); |
|
150 | - } |
|
139 | + /** |
|
140 | + * @param IUser $user |
|
141 | + * @param int $id |
|
142 | + */ |
|
143 | + public function deleteById(IUser $user, $id) { |
|
144 | + /* @var $qb IQueryBuilder */ |
|
145 | + $qb = $this->db->getQueryBuilder(); |
|
146 | + $qb->delete('authtoken') |
|
147 | + ->where($qb->expr()->eq('id', $qb->createNamedParameter($id))) |
|
148 | + ->andWhere($qb->expr()->eq('uid', $qb->createNamedParameter($user->getUID()))); |
|
149 | + $qb->execute(); |
|
150 | + } |
|
151 | 151 | |
152 | 152 | } |
@@ -27,10 +27,10 @@ |
||
27 | 27 | |
28 | 28 | class DefaultTokenCleanupJob extends Job { |
29 | 29 | |
30 | - protected function run($argument) { |
|
31 | - /* @var $provider IProvider */ |
|
32 | - $provider = OC::$server->query('OC\Authentication\Token\IProvider'); |
|
33 | - $provider->invalidateOldTokens(); |
|
34 | - } |
|
30 | + protected function run($argument) { |
|
31 | + /* @var $provider IProvider */ |
|
32 | + $provider = OC::$server->query('OC\Authentication\Token\IProvider'); |
|
33 | + $provider->invalidateOldTokens(); |
|
34 | + } |
|
35 | 35 | |
36 | 36 | } |