Configuration.php 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300
  1. <?php
  2. class FreshRSS_Configuration {
  3. private $filename;
  4. private $data = array(
  5. 'language' => 'en',
  6. 'old_entries' => 3,
  7. 'keep_history_default' => 0,
  8. 'ttl_default' => 3600,
  9. 'mail_login' => '',
  10. 'token' => '',
  11. 'passwordHash' => '', //CRYPT_BLOWFISH
  12. 'apiPasswordHash' => '', //CRYPT_BLOWFISH
  13. 'posts_per_page' => 20,
  14. 'view_mode' => 'normal',
  15. 'default_view' => FreshRSS_Entry::STATE_NOT_READ,
  16. 'auto_load_more' => true,
  17. 'display_posts' => false,
  18. 'display_categories' => false,
  19. 'hide_read_feeds' => true,
  20. 'onread_jump_next' => true,
  21. 'lazyload' => true,
  22. 'sticky_post' => true,
  23. 'reading_confirm' => false,
  24. 'sort_order' => 'DESC',
  25. 'anon_access' => false,
  26. 'mark_when' => array(
  27. 'article' => true,
  28. 'site' => true,
  29. 'scroll' => false,
  30. 'reception' => false,
  31. ),
  32. 'theme' => 'Origine',
  33. 'content_width' => 'thin',
  34. 'shortcuts' => array(
  35. 'mark_read' => 'r',
  36. 'mark_favorite' => 'f',
  37. 'go_website' => 'space',
  38. 'next_entry' => 'j',
  39. 'prev_entry' => 'k',
  40. 'first_entry' => 'home',
  41. 'last_entry' => 'end',
  42. 'collapse_entry' => 'c',
  43. 'load_more' => 'm',
  44. 'auto_share' => 's',
  45. 'focus_search' => 'a',
  46. ),
  47. 'topline_read' => true,
  48. 'topline_favorite' => true,
  49. 'topline_date' => true,
  50. 'topline_link' => true,
  51. 'bottomline_read' => true,
  52. 'bottomline_favorite' => true,
  53. 'bottomline_sharing' => true,
  54. 'bottomline_tags' => true,
  55. 'bottomline_date' => true,
  56. 'bottomline_link' => true,
  57. 'sharing' => array(),
  58. 'queries' => array(),
  59. );
  60. private $available_languages = array(
  61. 'en' => 'English',
  62. 'fr' => 'Français',
  63. );
  64. private $shares;
  65. public function __construct($user) {
  66. $this->filename = DATA_PATH . DIRECTORY_SEPARATOR . $user . '_user.php';
  67. $data = @include($this->filename);
  68. if (!is_array($data)) {
  69. throw new Minz_PermissionDeniedException($this->filename);
  70. }
  71. foreach ($data as $key => $value) {
  72. if (isset($this->data[$key])) {
  73. $function = '_' . $key;
  74. $this->$function($value);
  75. }
  76. }
  77. $this->data['user'] = $user;
  78. $this->shares = DATA_PATH . DIRECTORY_SEPARATOR . 'shares.php';
  79. $shares = @include($this->shares);
  80. if (!is_array($shares)) {
  81. throw new Minz_PermissionDeniedException($this->shares);
  82. }
  83. $this->data['shares'] = $shares;
  84. }
  85. public function save() {
  86. @rename($this->filename, $this->filename . '.bak.php');
  87. unset($this->data['shares']); // Remove shares because it is not intended to be stored in user configuration
  88. if (file_put_contents($this->filename, "<?php\n return " . var_export($this->data, true) . ';', LOCK_EX) === false) {
  89. throw new Minz_PermissionDeniedException($this->filename);
  90. }
  91. if (function_exists('opcache_invalidate')) {
  92. opcache_invalidate($this->filename); //Clear PHP 5.5+ cache for include
  93. }
  94. invalidateHttpCache();
  95. return true;
  96. }
  97. public function __get($name) {
  98. if (array_key_exists($name, $this->data)) {
  99. return $this->data[$name];
  100. } else {
  101. $trace = debug_backtrace();
  102. trigger_error('Undefined FreshRSS_Configuration->' . $name . 'in ' . $trace[0]['file'] . ' line ' . $trace[0]['line'], E_USER_NOTICE); //TODO: Use Minz exceptions
  103. return null;
  104. }
  105. }
  106. public function availableLanguages() {
  107. return $this->available_languages;
  108. }
  109. public function _language($value) {
  110. if (!isset($this->available_languages[$value])) {
  111. $value = 'en';
  112. }
  113. $this->data['language'] = $value;
  114. }
  115. public function _posts_per_page ($value) {
  116. $value = intval($value);
  117. $this->data['posts_per_page'] = $value > 0 ? $value : 10;
  118. }
  119. public function _view_mode ($value) {
  120. if ($value === 'global' || $value === 'reader') {
  121. $this->data['view_mode'] = $value;
  122. } else {
  123. $this->data['view_mode'] = 'normal';
  124. }
  125. }
  126. public function _default_view ($value) {
  127. $this->data['default_view'] = $value === FreshRSS_Entry::STATE_ALL ? FreshRSS_Entry::STATE_ALL : FreshRSS_Entry::STATE_NOT_READ;
  128. }
  129. public function _display_posts ($value) {
  130. $this->data['display_posts'] = ((bool)$value) && $value !== 'no';
  131. }
  132. public function _display_categories ($value) {
  133. $this->data['display_categories'] = ((bool)$value) && $value !== 'no';
  134. }
  135. public function _hide_read_feeds($value) {
  136. $this->data['hide_read_feeds'] = (bool)$value;
  137. }
  138. public function _onread_jump_next ($value) {
  139. $this->data['onread_jump_next'] = ((bool)$value) && $value !== 'no';
  140. }
  141. public function _lazyload ($value) {
  142. $this->data['lazyload'] = ((bool)$value) && $value !== 'no';
  143. }
  144. public function _sticky_post($value) {
  145. $this->data['sticky_post'] = ((bool)$value) && $value !== 'no';
  146. }
  147. public function _reading_confirm($value) {
  148. $this->data['reading_confirm'] = ((bool)$value) && $value !== 'no';
  149. }
  150. public function _sort_order ($value) {
  151. $this->data['sort_order'] = $value === 'ASC' ? 'ASC' : 'DESC';
  152. }
  153. public function _old_entries($value) {
  154. $value = intval($value);
  155. $this->data['old_entries'] = $value > 0 ? $value : 3;
  156. }
  157. public function _keep_history_default($value) {
  158. $value = intval($value);
  159. $this->data['keep_history_default'] = $value >= -1 ? $value : 0;
  160. }
  161. public function _ttl_default($value) {
  162. $value = intval($value);
  163. $this->data['ttl_default'] = $value >= -1 ? $value : 3600;
  164. }
  165. public function _shortcuts ($values) {
  166. foreach ($values as $key => $value) {
  167. if (isset($this->data['shortcuts'][$key])) {
  168. $this->data['shortcuts'][$key] = $value;
  169. }
  170. }
  171. }
  172. public function _passwordHash ($value) {
  173. $this->data['passwordHash'] = ctype_graph($value) && (strlen($value) >= 60) ? $value : '';
  174. }
  175. public function _apiPasswordHash ($value) {
  176. $this->data['apiPasswordHash'] = ctype_graph($value) && (strlen($value) >= 60) ? $value : '';
  177. }
  178. public function _mail_login ($value) {
  179. $value = filter_var($value, FILTER_VALIDATE_EMAIL);
  180. if ($value) {
  181. $this->data['mail_login'] = $value;
  182. } else {
  183. $this->data['mail_login'] = '';
  184. }
  185. }
  186. public function _anon_access ($value) {
  187. $this->data['anon_access'] = ((bool)$value) && $value !== 'no';
  188. }
  189. public function _mark_when ($values) {
  190. foreach ($values as $key => $value) {
  191. if (isset($this->data['mark_when'][$key])) {
  192. $this->data['mark_when'][$key] = ((bool)$value) && $value !== 'no';
  193. }
  194. }
  195. }
  196. public function _sharing ($values) {
  197. $this->data['sharing'] = array();
  198. foreach ($values as $value) {
  199. if (!is_array($value)) {
  200. continue;
  201. }
  202. // Verify URL and add default value when needed
  203. if (isset($value['url'])) {
  204. $is_url = (
  205. filter_var ($value['url'], FILTER_VALIDATE_URL) ||
  206. (version_compare(PHP_VERSION, '5.3.3', '<') &&
  207. (strpos($value, '-') > 0) &&
  208. ($value === filter_var($value, FILTER_SANITIZE_URL)))
  209. ); //PHP bug #51192
  210. if (!$is_url) {
  211. continue;
  212. }
  213. } else {
  214. $value['url'] = null;
  215. }
  216. // Add a default name
  217. if (empty($value['name'])) {
  218. $value['name'] = $value['type'];
  219. }
  220. $this->data['sharing'][] = $value;
  221. }
  222. }
  223. public function _queries ($values) {
  224. $this->data['queries'] = array();
  225. foreach ($values as $value) {
  226. $value = array_filter($value);
  227. $params = $value;
  228. unset($params['name']);
  229. unset($params['url']);
  230. $value['url'] = Minz_Url::display(array('params' => $params));
  231. $this->data['queries'][] = $value;
  232. }
  233. }
  234. public function _theme($value) {
  235. $this->data['theme'] = $value;
  236. }
  237. public function _content_width($value) {
  238. if ($value === 'medium' ||
  239. $value === 'large' ||
  240. $value === 'no_limit') {
  241. $this->data['content_width'] = $value;
  242. } else {
  243. $this->data['content_width'] = 'thin';
  244. }
  245. }
  246. public function _token($value) {
  247. $this->data['token'] = $value;
  248. }
  249. public function _auto_load_more($value) {
  250. $this->data['auto_load_more'] = ((bool)$value) && $value !== 'no';
  251. }
  252. public function _topline_read($value) {
  253. $this->data['topline_read'] = ((bool)$value) && $value !== 'no';
  254. }
  255. public function _topline_favorite($value) {
  256. $this->data['topline_favorite'] = ((bool)$value) && $value !== 'no';
  257. }
  258. public function _topline_date($value) {
  259. $this->data['topline_date'] = ((bool)$value) && $value !== 'no';
  260. }
  261. public function _topline_link($value) {
  262. $this->data['topline_link'] = ((bool)$value) && $value !== 'no';
  263. }
  264. public function _bottomline_read($value) {
  265. $this->data['bottomline_read'] = ((bool)$value) && $value !== 'no';
  266. }
  267. public function _bottomline_favorite($value) {
  268. $this->data['bottomline_favorite'] = ((bool)$value) && $value !== 'no';
  269. }
  270. public function _bottomline_sharing($value) {
  271. $this->data['bottomline_sharing'] = ((bool)$value) && $value !== 'no';
  272. }
  273. public function _bottomline_tags($value) {
  274. $this->data['bottomline_tags'] = ((bool)$value) && $value !== 'no';
  275. }
  276. public function _bottomline_date($value) {
  277. $this->data['bottomline_date'] = ((bool)$value) && $value !== 'no';
  278. }
  279. public function _bottomline_link($value) {
  280. $this->data['bottomline_link'] = ((bool)$value) && $value !== 'no';
  281. }
  282. }