mirror of https://github.com/FreshRSS/FreshRSS.git
307 lines
7.4 KiB
PHP
307 lines
7.4 KiB
PHP
<?php
|
||
|
||
/**
|
||
* Manage the sharing options in FreshRSS.
|
||
*/
|
||
class FreshRSS_Share {
|
||
/**
|
||
* The list of available sharing options.
|
||
*/
|
||
private static $list_sharing = array();
|
||
|
||
/**
|
||
* Register a new sharing option.
|
||
* @param array<string,string|array<string>> $share_options is an array defining the share option.
|
||
*/
|
||
public static function register($share_options) {
|
||
$type = $share_options['type'];
|
||
|
||
if (isset(self::$list_sharing[$type])) {
|
||
return;
|
||
}
|
||
|
||
$HTMLtag = isset($share_options['HTMLtag']) ? $share_options['HTMLtag'] : 'link';
|
||
$isDeprecated = isset($share_options['deprecated']) ? $share_options['deprecated'] : false;
|
||
$help_url = isset($share_options['help']) ? $share_options['help'] : '';
|
||
$field = isset($share_options['field']) ? $share_options['field'] : null;
|
||
self::$list_sharing[$type] = new FreshRSS_Share(
|
||
$type, $share_options['url'], $share_options['transform'],
|
||
$share_options['form'], $help_url, $share_options['method'],
|
||
$field, $HTMLtag, $isDeprecated
|
||
);
|
||
}
|
||
|
||
/**
|
||
* Register sharing options in a file.
|
||
* @param string $filename the name of the file to load.
|
||
*/
|
||
public static function load($filename) {
|
||
$shares_from_file = @include($filename);
|
||
if (!is_array($shares_from_file)) {
|
||
$shares_from_file = array();
|
||
}
|
||
|
||
foreach ($shares_from_file as $share_type => $share_options) {
|
||
$share_options['type'] = $share_type;
|
||
self::register($share_options);
|
||
}
|
||
|
||
uasort(self::$list_sharing, function ($a, $b) {
|
||
return strcasecmp($a->name(), $b->name());
|
||
});
|
||
}
|
||
|
||
/**
|
||
* Return the list of sharing options.
|
||
* @return array<FreshRSS_Share>
|
||
*/
|
||
public static function enum() {
|
||
return self::$list_sharing;
|
||
}
|
||
|
||
/**
|
||
* Return FreshRSS_Share object related to the given type.
|
||
* @param string $type the share type, null if $type is not registered.
|
||
*/
|
||
public static function get($type) {
|
||
if (!isset(self::$list_sharing[$type])) {
|
||
return null;
|
||
}
|
||
|
||
return self::$list_sharing[$type];
|
||
}
|
||
|
||
/**
|
||
*
|
||
*/
|
||
private $type = '';
|
||
private $name = '';
|
||
private $url_transform = '';
|
||
private $transform = array();
|
||
private $form_type = 'simple';
|
||
private $help_url = '';
|
||
private $custom_name = null;
|
||
private $base_url = null;
|
||
private $id = null;
|
||
private $title = null;
|
||
private $link = null;
|
||
private $isDeprecated = false;
|
||
private $method = 'GET';
|
||
private $field;
|
||
private $HTMLtag = 'link';
|
||
|
||
/**
|
||
* Create a FreshRSS_Share object.
|
||
* @param string $type is a unique string defining the kind of share option.
|
||
* @param string $url_transform defines the url format to use in order to share.
|
||
* @param array<string> $transform is an array of transformations to apply on link and title.
|
||
* @param string $form_type defines which form we have to use to complete. "simple"
|
||
* is typically for a centralized service while "advanced" is for
|
||
* decentralized ones.
|
||
* @param string $help_url is an optional url to give help on this option.
|
||
* @param string $method defines the sharing method (GET or POST)
|
||
*/
|
||
private function __construct($type, $url_transform, $transform, $form_type, $help_url, $method, $field, $HTMLtag, $isDeprecated = false) {
|
||
$this->type = $type;
|
||
$this->name = _t('gen.share.' . $type);
|
||
$this->url_transform = $url_transform;
|
||
$this->help_url = $help_url;
|
||
$this->HTMLtag = $HTMLtag;
|
||
$this->isDeprecated = $isDeprecated;
|
||
|
||
if (!is_array($transform)) {
|
||
$transform = array();
|
||
}
|
||
$this->transform = $transform;
|
||
|
||
if (!in_array($form_type, array('simple', 'advanced'))) {
|
||
$form_type = 'simple';
|
||
}
|
||
$this->form_type = $form_type;
|
||
if (!in_array($method, array('GET', 'POST'))) {
|
||
$method = 'GET';
|
||
}
|
||
$this->method = $method;
|
||
$this->field = $field;
|
||
}
|
||
|
||
/**
|
||
* Update a FreshRSS_Share object with information from an array.
|
||
* @param array<string,string> $options is a list of information to update where keys should be
|
||
* in this list: name, url, id, title, link.
|
||
*/
|
||
public function update($options) {
|
||
$available_options = array(
|
||
'name' => 'custom_name',
|
||
'url' => 'base_url',
|
||
'id' => 'id',
|
||
'title' => 'title',
|
||
'link' => 'link',
|
||
'method' => 'method',
|
||
'field' => 'field',
|
||
);
|
||
|
||
foreach ($options as $key => $value) {
|
||
if (isset($available_options[$key])) {
|
||
$this->{$available_options[$key]} = $value;
|
||
}
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Return the current type of the share option.
|
||
*/
|
||
public function type() {
|
||
return $this->type;
|
||
}
|
||
|
||
/**
|
||
* Return the current method of the share option.
|
||
*/
|
||
public function method() {
|
||
return $this->method;
|
||
}
|
||
|
||
/**
|
||
* Return the current field of the share option. It’s null for shares
|
||
* using the GET method.
|
||
*/
|
||
public function field() {
|
||
return $this->field;
|
||
}
|
||
|
||
/**
|
||
* Return the current form type of the share option.
|
||
*/
|
||
public function formType() {
|
||
return $this->form_type;
|
||
}
|
||
|
||
/**
|
||
* Return the current help url of the share option.
|
||
*/
|
||
public function help() {
|
||
return $this->help_url;
|
||
}
|
||
|
||
/**
|
||
* Return the type of HTML tag of the share option.
|
||
*/
|
||
public function HTMLtag() {
|
||
return $this->HTMLtag;
|
||
}
|
||
|
||
/**
|
||
* Return the current name of the share option.
|
||
*/
|
||
public function name($real = false) {
|
||
if ($real || is_null($this->custom_name) || empty($this->custom_name)) {
|
||
return $this->name;
|
||
} else {
|
||
return $this->custom_name;
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Return the current base url of the share option.
|
||
*/
|
||
public function baseUrl() {
|
||
return $this->base_url;
|
||
}
|
||
|
||
/**
|
||
* Return the deprecated status of the share option.
|
||
*/
|
||
public function isDeprecated() {
|
||
return $this->isDeprecated;
|
||
}
|
||
|
||
/**
|
||
* Return the current url by merging url_transform and base_url.
|
||
*/
|
||
public function url() {
|
||
$matches = array(
|
||
'~ID~',
|
||
'~URL~',
|
||
'~TITLE~',
|
||
'~LINK~',
|
||
);
|
||
$replaces = array(
|
||
$this->id(),
|
||
$this->base_url,
|
||
$this->title(),
|
||
$this->link(),
|
||
);
|
||
return str_replace($matches, $replaces, $this->url_transform);
|
||
}
|
||
|
||
/**
|
||
* Return the id.
|
||
* @param bool $raw true if we should get the id without transformations.
|
||
*/
|
||
public function id($raw = false) {
|
||
if ($raw) {
|
||
return $this->id;
|
||
}
|
||
|
||
return $this->transform($this->id, $this->getTransform('id'));
|
||
}
|
||
|
||
/**
|
||
* Return the title.
|
||
* @param bool $raw true if we should get the title without transformations.
|
||
*/
|
||
public function title($raw = false) {
|
||
if ($raw) {
|
||
return $this->title;
|
||
}
|
||
|
||
return $this->transform($this->title, $this->getTransform('title'));
|
||
}
|
||
|
||
/**
|
||
* Return the link.
|
||
* @param bool $raw true if we should get the link without transformations.
|
||
*/
|
||
public function link($raw = false) {
|
||
if ($raw) {
|
||
return $this->link;
|
||
}
|
||
|
||
return $this->transform($this->link, $this->getTransform('link'));
|
||
}
|
||
|
||
/**
|
||
* Transform a data with the given functions.
|
||
* @param string $data the data to transform.
|
||
* @param array<string> $transform an array containing a list of functions to apply.
|
||
* @return mixed the transformed data.
|
||
*/
|
||
private static function transform($data, $transform) {
|
||
if (!is_array($transform) || empty($transform)) {
|
||
return $data;
|
||
}
|
||
|
||
foreach ($transform as $action) {
|
||
if (is_string($action) && $action != '') {
|
||
$data = call_user_func($action, $data);
|
||
}
|
||
}
|
||
|
||
return $data;
|
||
}
|
||
|
||
/**
|
||
* Get the list of transformations for the given attribute.
|
||
* @param string $attr the attribute of which we want the transformations.
|
||
* @return array<string> containing a list of transformations to apply.
|
||
*/
|
||
private function getTransform($attr) {
|
||
if (array_key_exists($attr, $this->transform)) {
|
||
return $this->transform[$attr];
|
||
}
|
||
|
||
return $this->transform;
|
||
}
|
||
}
|