daux.io/libs/Daux.php

367 regels
10 KiB
PHP

<?php namespace Todaymade\Daux;
2015-07-17 18:34:00 +02:00
use Symfony\Component\Console\Output\NullOutput;
2015-07-29 22:31:41 +02:00
use Todaymade\Daux\ContentTypes\ContentTypeHandler;
use Todaymade\Daux\Tree\Builder;
use Todaymade\Daux\Tree\Content;
use Todaymade\Daux\Tree\Directory;
use Todaymade\Daux\Tree\Root;
2015-04-22 12:23:57 +02:00
2015-04-23 00:32:30 +02:00
class Daux
{
const STATIC_MODE = 'DAUX_STATIC';
const LIVE_MODE = 'DAUX_LIVE';
2015-07-18 21:45:38 +02:00
/** @var string */
2015-04-23 00:32:30 +02:00
public $local_base;
2015-07-18 21:45:38 +02:00
/** @var string */
2015-07-14 23:35:47 +02:00
public $internal_base;
2015-07-18 21:45:38 +02:00
/** @var \Todaymade\Daux\Format\Base\Generator */
protected $generator;
2015-07-29 22:31:41 +02:00
/** @var ContentTypeHandler */
protected $typeHandler;
/**
* @var string[]
*/
protected $validExtensions;
2015-07-18 21:45:38 +02:00
/** @var Processor */
2015-07-17 18:34:00 +02:00
protected $processor;
2015-07-18 21:45:38 +02:00
/** @var Tree\Root */
2015-04-23 00:32:30 +02:00
public $tree;
2015-07-17 23:38:06 +02:00
2015-07-18 21:45:38 +02:00
/** @var Config */
2015-04-23 00:32:30 +02:00
public $options;
2015-07-18 21:45:38 +02:00
/** @var string */
2015-04-23 00:32:30 +02:00
private $mode;
2015-07-19 14:05:12 +02:00
/** @var bool */
private $merged_tree = false;
2015-07-18 21:45:38 +02:00
/**
* @param string $mode
*/
2015-04-23 00:32:30 +02:00
public function __construct($mode)
{
2015-04-23 00:32:30 +02:00
$this->mode = $mode;
2015-07-14 23:35:47 +02:00
$this->local_base = $this->internal_base = dirname(__DIR__);
2015-07-18 21:45:38 +02:00
// In case we're inside the phar archive
// we save the path to the directory
// in which it is contained
2015-07-14 23:35:47 +02:00
if (defined('PHAR_DIR')) {
$this->local_base = PHAR_DIR;
}
// global.json
$this->loadBaseConfiguration();
2015-04-23 00:32:30 +02:00
}
2015-07-18 21:45:38 +02:00
/**
* @param string $override_file
* @throws Exception
*/
public function initializeConfiguration($override_file = 'config.json')
2015-04-23 00:32:30 +02:00
{
// Validate and set theme path
$this->getParams()->setDocumentationDirectory($docs_path = $this->normalizeDocumentationPath());
// Read documentation overrides
$this->loadConfiguration($docs_path . DIRECTORY_SEPARATOR . 'config.json');
2015-07-20 15:59:52 +02:00
// Read command line overrides
if (!is_null($override_file)) {
$this->loadConfiguration($this->local_base . DIRECTORY_SEPARATOR . $override_file);
2015-07-20 15:59:52 +02:00
}
// Validate and set theme path
$this->options['themes_path'] = $this->normalizeThemePath($this->getParams()->getThemesDirectory());
2015-07-20 15:59:52 +02:00
// Set a valid default timezone
if (isset($this->options['timezone'])) {
date_default_timezone_set($this->options['timezone']);
} elseif (!ini_get('date.timezone')) {
date_default_timezone_set('GMT');
}
2015-04-23 00:32:30 +02:00
}
2016-07-28 22:48:50 +02:00
public function normalizeThemePath($path)
{
if (is_dir($path)) {
return $path;
}
$newPath = $this->local_base . DIRECTORY_SEPARATOR . $path;
if (is_dir($newPath)) {
return $newPath;
}
throw new Exception('The Themes directory does not exist. Check the path again : ' . $path);
}
public function normalizeDocumentationPath()
{
// When running through `daux --serve` we set an environment variable to know where we started from
$env = getenv('DAUX_SOURCE');
if ($env && is_dir($env)) {
return $env;
}
$path = $this->getParams()->getDocumentationDirectory();
if (is_dir($path)) {
return getcwd() . '/' . $path;
}
2015-07-31 12:53:22 +02:00
throw new Exception('The Docs directory does not exist. Check the path again : ' . $path);
}
2015-07-18 21:45:38 +02:00
/**
* Load and validate the global configuration
*
* @throws Exception
*/
2015-07-20 15:59:52 +02:00
protected function loadBaseConfiguration()
2015-04-23 00:32:30 +02:00
{
2015-07-20 15:59:52 +02:00
$this->options = new Config();
// Set the default configuration
$this->options->merge([
'docs_directory' => 'docs',
2016-07-27 21:32:51 +02:00
'valid_content_extensions' => ['md', 'markdown'],
//Paths and tree
'mode' => $this->mode,
'local_base' => $this->local_base,
'templates' => 'templates',
'index_key' => 'index.html',
'base_page' => '',
'base_url' => '',
2015-07-20 15:59:52 +02:00
]);
2015-07-20 15:59:52 +02:00
// Load the global configuration
$this->loadConfiguration($this->local_base . DIRECTORY_SEPARATOR . 'global.json', false);
2015-04-23 00:32:30 +02:00
}
2015-07-20 15:59:52 +02:00
/**
* @param string $config_file
* @param bool $optional
* @throws Exception
*/
protected function loadConfiguration($config_file, $optional = true)
{
if (!file_exists($config_file)) {
if ($optional) {
return;
}
2015-07-20 15:59:52 +02:00
throw new Exception('The configuration file is missing. Check path : ' . $config_file);
2015-04-23 00:32:30 +02:00
}
2015-07-20 15:59:52 +02:00
$config = json_decode(file_get_contents($config_file), true);
if (!isset($config)) {
throw new Exception('The configuration file "' . $config_file . '" is corrupt. Is your JSON well-formed ?');
}
2015-07-20 15:59:52 +02:00
$this->options->merge($config);
2015-04-23 00:32:30 +02:00
}
2015-07-18 21:45:38 +02:00
/**
* Generate the tree that will be used
*/
2015-07-19 23:17:57 +02:00
public function generateTree()
2015-04-23 00:32:30 +02:00
{
$this->options['valid_content_extensions'] = $this->getContentExtensions();
$this->tree = new Root($this->getParams());
Builder::build($this->tree, $this->options['ignore']);
2015-04-23 00:32:30 +02:00
if (!empty($this->options['languages'])) {
foreach ($this->options['languages'] as $key => $node) {
2015-07-18 21:45:38 +02:00
$this->tree->getEntries()[$key]->setTitle($node);
}
}
// Enhance the tree with processors
$this->getProcessor()->manipulateTree($this->tree);
// Sort the tree one last time before it is finalized
$this->sortTree($this->tree);
$this->finalizeTree($this->tree);
}
public function sortTree(Directory $current)
{
$current->sort();
foreach ($current->getEntries() as $entry) {
if ($entry instanceof Directory) {
$this->sortTree($entry);
}
}
}
public function finalizeTree(Directory $current, $prev = null)
{
foreach ($current->getEntries() as $entry) {
if ($entry instanceof Directory) {
$prev = $this->finalizeTree($entry, $prev);
} elseif ($entry instanceof Content) {
if ($prev) {
$prev->setNext($entry);
$entry->setPrevious($prev);
}
$prev = $entry;
}
}
return $prev;
2015-04-23 00:32:30 +02:00
}
/**
2015-07-14 23:35:47 +02:00
* @return Config
*/
2015-04-23 00:32:30 +02:00
public function getParams()
{
2015-07-19 14:05:12 +02:00
if ($this->tree && !$this->merged_tree) {
$this->options['tree'] = $this->tree;
$this->options['index'] = $this->tree->getIndexPage() ?: $this->tree->getFirstPage();
if ($this->options->isMultilanguage()) {
2015-04-22 12:23:57 +02:00
foreach ($this->options['languages'] as $key => $name) {
$this->options['entry_page'][$key] = $this->tree->getEntries()[$key]->getFirstPage();
2015-04-22 12:23:57 +02:00
}
} else {
$this->options['entry_page'] = $this->tree->getFirstPage();
}
2015-07-19 14:05:12 +02:00
$this->merged_tree = true;
}
return $this->options;
2015-04-22 12:23:57 +02:00
}
2015-07-17 18:34:00 +02:00
/**
* @return Processor
*/
public function getProcessor()
{
if (!$this->processor) {
$this->processor = new Processor($this, new NullOutput(), 0);
}
return $this->processor;
}
/**
* @param Processor $processor
*/
public function setProcessor(Processor $processor)
{
$this->processor = $processor;
// This is not the cleanest but it's
// the best i've found to use the
// processor in very remote places
$this->options['processor_instance'] = $processor;
}
public function getGenerators()
{
$default = [
'confluence' => '\Todaymade\Daux\Format\Confluence\Generator',
'html-file' => '\Todaymade\Daux\Format\HTMLFile\Generator',
'html' => '\Todaymade\Daux\Format\HTML\Generator',
];
$extended = $this->getProcessor()->addGenerators();
return array_replace($default, $extended);
2015-07-17 18:34:00 +02:00
}
public function getProcessorClass()
{
$processor = $this->getParams()['processor'];
if (empty($processor)) {
return null;
}
2016-07-27 21:32:51 +02:00
$class = '\\Todaymade\\Daux\\Extension\\' . $processor;
if (!class_exists($class)) {
throw new \RuntimeException("Class '$class' not found. We cannot use it as a Processor");
}
2016-07-27 21:32:51 +02:00
if (!array_key_exists('Todaymade\\Daux\\Processor', class_parents($class))) {
2016-01-31 11:59:35 +01:00
throw new \RuntimeException("Class '$class' invalid, should extend '\\Todaymade\\Daux\\Processor'");
}
return $class;
}
/**
* @return \Todaymade\Daux\Format\Base\Generator
*/
public function getGenerator()
{
if ($this->generator) {
return $this->generator;
}
$generators = $this->getGenerators();
$format = $this->getParams()->getFormat();
if (!array_key_exists($format, $generators)) {
throw new \RuntimeException("The format '$format' doesn't exist, did you forget to set your processor ?");
}
$class = $generators[$format];
if (!class_exists($class)) {
throw new \RuntimeException("Class '$class' not found. We cannot use it as a Generator");
}
$interface = 'Todaymade\Daux\Format\Base\Generator';
if (!in_array('Todaymade\Daux\Format\Base\Generator', class_implements($class))) {
throw new \RuntimeException("The class '$class' does not implement the '$interface' interface");
}
return $this->generator = new $class($this);
}
public function getContentTypeHandler()
{
if ($this->typeHandler) {
return $this->typeHandler;
}
$base_types = $this->getGenerator()->getContentTypes();
$extended = $this->getProcessor()->addContentType();
$types = array_merge($base_types, $extended);
return $this->typeHandler = new ContentTypeHandler($types);
}
/**
* Get all content file extensions
*
* @return string[]
*/
public function getContentExtensions()
{
if ($this->validExtensions) {
return $this->validExtensions;
}
return $this->validExtensions = $this->getContentTypeHandler()->getContentExtensions();
}
2015-04-23 00:32:30 +02:00
}