-
Notifications
You must be signed in to change notification settings - Fork 22
/
Provider.php
179 lines (151 loc) · 4.13 KB
/
Provider.php
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
<?php
/**
* @copyright Copyright (c) 2019 Felix Nüsse <felix.nuesse@t-online.de>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program 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 program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCA\Unsplash\ProviderHandler;
use OCP\IConfig;
abstract class Provider {
const SIZE_SMALL = 0;
const SIZE_NORMAL = 1;
const SIZE_HIGH = 2;
const SIZE_ULTRA = 3;
/**
* @var IConfig
*/
protected $config;
/**
* @var string
*/
protected $appName;
/**
* @var string
*/
private $providerName;
/**
* // Please override this value for your own provider.
* @var string
*/
public string $DEFAULT_SEARCH="nature";
public bool $ALLOW_CUSTOMIZING = true;
public bool $REQUIRES_TOKEN = false;
public string $DEFAULT_TOKEN="";
/**
* Provider constructor.
*
* @param $appName
* @param IConfig $config
* @param $pName
*/
public function __construct( $appName, IConfig $config, $pName) {
$this->config = $config;
$this->appName = $appName;
$this->providerName = $pName;
}
/**
* This sets a custom search query if the provider supports this.
*
* @param string $term
*/
public function setCustomSearchTerms(string $term): void
{
if($this->ALLOW_CUSTOMIZING) {
$this->config->setAppValue($this->appName, 'splash/provider/'.$this->providerName.'/searchterms', $term);
}
}
/**
*
* This returns the custom searchterm
* It is not filtered!
* @return string
*/
public function getCustomSearchterms(): string {
if(!$this->ALLOW_CUSTOMIZING) {
return "";
}
$term = $this->config->getAppValue($this->appName, 'splash/provider/'.$this->providerName.'/searchterms', $this->DEFAULT_SEARCH);
if($term == "") {
return $this->DEFAULT_SEARCH;
}
return $term;
}
/**
*
* This returns a single searchterm. It will be restricted to letters, and lowercase.
* This filtering i s there to prevent url hijacking or malforming due to searchterms
* @return string
*/
public function getRandomSearchTerm(): string {
$termarray = explode(",", $this->getCustomSearchterms());
shuffle($termarray);
$term = strtolower($termarray[0]);
// only allow letters as searchterm
$term = preg_replace('/[^a-z]/i','', $term);
return $term;
}
/**
* Returns the providername
* @return string
*/
public function getName(): string
{
return $this->providerName;
}
/**
* Returns if the provider is customizable
* @return string
*/
public function isCustomizable(): bool
{
return $this->ALLOW_CUSTOMIZING;
}
/**
* Returns if the provider requires an api token
* @return string
*/
public function requiresToken(): bool
{
return $this->REQUIRES_TOKEN;
}
/**
*
* This returns the token.
* It either returns the default or the stored token.
*
* @return string
*/
public function getToken(): string {
if(!$this->REQUIRES_TOKEN) {
return "";
}
$token = $this->config->getAppValue($this->appName, 'splash/provider/'.$this->providerName.'/token', $this->DEFAULT_TOKEN);
return $token;
}
/*
* This should return all URLS which need to be whitelisted for csrf
*/
public abstract function getWhitelistResourceUrls();
/*
* This should return a url to a random image
*/
public abstract function getRandomImageUrl($size);
/*
* This should return a url to a random image filtered by $search
*/
public abstract function getRandomImageUrlBySearchTerm($search, $size);
}