$bridgeClassName The bridge name * @param array $formats A list of formats * @param bool $isActive Indicates if the bridge is active or not * @return string The bridge card */ public static function displayBridgeCard($bridgeClassName, $formats, $isActive = true) { $bridgeFactory = new BridgeFactory(); $bridge = $bridgeFactory->create($bridgeClassName); $isHttps = strpos($bridge->getURI(), 'https') === 0; $uri = $bridge->getURI(); $name = $bridge->getName(); $icon = $bridge->getIcon(); $description = $bridge->getDescription(); $parameters = $bridge->getParameters(); if (Configuration::getConfig('proxy', 'url') && Configuration::getConfig('proxy', 'by_bridge')) { $parameters['global']['_noproxy'] = [ 'name' => 'Disable proxy (' . (Configuration::getConfig('proxy', 'name') ?: Configuration::getConfig('proxy', 'url')) . ')', 'type' => 'checkbox' ]; } if (CUSTOM_CACHE_TIMEOUT) { $parameters['global']['_cache_timeout'] = [ 'name' => 'Cache timeout in seconds', 'type' => 'number', 'defaultValue' => $bridge->getCacheTimeout() ]; } $card = <<

{$name}

{$description}

CARD; // If we don't have any parameter for the bridge, we print a generic form to load it. if (count($parameters) === 0) { $card .= self::getForm($bridgeClassName, $formats, $isActive, $isHttps); // Display form with cache timeout and/or noproxy options (if enabled) when bridge has no parameters } elseif (count($parameters) === 1 && array_key_exists('global', $parameters)) { $card .= self::getForm($bridgeClassName, $formats, $isActive, $isHttps, '', $parameters['global']); } else { foreach ($parameters as $parameterName => $parameter) { if (!is_numeric($parameterName) && $parameterName === 'global') { continue; } if (array_key_exists('global', $parameters)) { $parameter = array_merge($parameter, $parameters['global']); } if (!is_numeric($parameterName)) { $card .= '
' . $parameterName . '
' . PHP_EOL; } $card .= self::getForm($bridgeClassName, $formats, $isActive, $isHttps, $parameterName, $parameter); } } $card .= sprintf('', $bridgeClassName); if ($bridge->getDonationURI() !== '' && Configuration::getConfig('admin', 'donations')) { $card .= sprintf( '

%s ~ Donate

', $bridge->getMaintainer(), $bridge->getDonationURI() ); } else { $card .= sprintf('

%s

', $bridge->getMaintainer()); } $card .= ''; return $card; } /** * Get the form header for a bridge card * * @param class-string $bridgeClassName The bridge name * @param bool $isHttps If disabled, adds a warning to the form * @return string The form header */ private static function getFormHeader($bridgeClassName, $isHttps = false, $parameterName = '') { $form = << EOD; if (!empty($parameterName)) { $form .= sprintf('', $parameterName); } if (!$isHttps) { $form .= '
Warning : This bridge is not fetching its content through a secure connection
'; } return $form; } /** * Get the form body for a bridge * * @param class-string $bridgeClassName The bridge name * @param array $formats A list of supported formats * @param bool $isActive Indicates if a bridge is enabled or not * @param bool $isHttps Indicates if a bridge uses HTTPS or not * @param string $parameterName Sets the bridge context for the current form * @param array $parameters The bridge parameters * @return string The form body */ private static function getForm( $bridgeClassName, $formats, $isActive = false, $isHttps = false, $parameterName = '', $parameters = [] ) { $form = self::getFormHeader($bridgeClassName, $isHttps, $parameterName); if (count($parameters) > 0) { $form .= '
'; foreach ($parameters as $id => $inputEntry) { if (!isset($inputEntry['exampleValue'])) { $inputEntry['exampleValue'] = ''; } if (!isset($inputEntry['defaultValue'])) { $inputEntry['defaultValue'] = ''; } $idArg = 'arg-' . urlencode($bridgeClassName) . '-' . urlencode($parameterName) . '-' . urlencode($id); $form .= '' . PHP_EOL; if (!isset($inputEntry['type']) || $inputEntry['type'] === 'text') { $form .= self::getTextInput($inputEntry, $idArg, $id); } elseif ($inputEntry['type'] === 'number') { $form .= self::getNumberInput($inputEntry, $idArg, $id); } elseif ($inputEntry['type'] === 'list') { $form .= self::getListInput($inputEntry, $idArg, $id); } elseif ($inputEntry['type'] === 'checkbox') { $form .= self::getCheckboxInput($inputEntry, $idArg, $id); } if (isset($inputEntry['title'])) { $title_filtered = filter_var($inputEntry['title'], FILTER_SANITIZE_FULL_SPECIAL_CHARS); $form .= 'i'; } else { $form .= ''; } } $form .= '
'; } if ($isActive) { $form .= ''; } else { $form .= 'Inactive'; } return $form . '' . PHP_EOL; } /** * Get input field attributes * * @param array $entry The current entry * @return string The input field attributes */ private static function getInputAttributes($entry) { $retVal = ''; if (isset($entry['required']) && $entry['required'] === true) { $retVal .= ' required'; } if (isset($entry['pattern'])) { $retVal .= ' pattern="' . $entry['pattern'] . '"'; } return $retVal; } /** * Get text input * * @param array $entry The current entry * @param string $id The field ID * @param string $name The field name * @return string The text input field */ private static function getTextInput($entry, $id, $name) { return '' . PHP_EOL; } /** * Get number input * * @param array $entry The current entry * @param string $id The field ID * @param string $name The field name * @return string The number input field */ private static function getNumberInput($entry, $id, $name) { return '' . PHP_EOL; } /** * Get list input * * @param array $entry The current entry * @param string $id The field ID * @param string $name The field name * @return string The list input field */ private static function getListInput($entry, $id, $name) { if (isset($entry['required']) && $entry['required'] === true) { Debug::log('The "required" attribute is not supported for lists.'); unset($entry['required']); } $list = ''; return $list; } /** * Get checkbox input * * @param array $entry The current entry * @param string $id The field ID * @param string $name The field name * @return string The checkbox input field */ private static function getCheckboxInput($entry, $id, $name) { if (isset($entry['required']) && $entry['required'] === true) { Debug::log('The "required" attribute is not supported for checkboxes.'); unset($entry['required']); } return '' . PHP_EOL; } }