<?php

/*
 * Textpattern Content Management System
 * https://textpattern.com/
 *
 * Copyright (C) 2020 The Textpattern Development Team
 *
 * This file is part of Textpattern.
 *
 * Textpattern is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation, version 2.
 *
 * Textpattern 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Textpattern. If not, see <https://www.gnu.org/licenses/>.
 */

/**
 * Asset Base
 *
 * Extended by CSS, Form and Page.
 *
 * @since   4.7.0
 * @package Skin
 */

namespace Textpattern\Skin;

abstract class AssetBase extends CommonBase implements AssetInterface
{
    /**
     * The directory in the themes folder in which assets of a particular type can be found.
     *
     * @var string Directory name.
     * @see setDir(), getDir().
     */

    protected static $dir;

    /**
     * Asset related default subdirectory to store exported files.
     *
     * @var string Asset subdirectory name.
     * @see getDefaultSubdir().
     */

    protected static $defaultSubdir;

    /**
     * Asset related table field used as subdirectories.
     *
     * @var string
     * @see getSubdirField().
     */

    protected static $subdirField;

    /**
     * Asset related table field(s) used as asset file contents.
     *
     * @var string Field name (could accept an array in the future for JSON contents)
     * @see getFileContentsField().
     */

    protected static $fileContentsField;

    /**
     * Forms that Textpattern expects to exist for smooth tag operation.
     *
     * Asset related essential rows as an associative array of the following
     * fields and their value: 'name', ($subdirField, ) $fileContentsField.
     *
     * @var array Associative array of the following fields and their value:
     *            'name', ($subdirField, ) $fileContentsField.
     * @see getEssential().
     */

    protected static $essential = array();

    /**
     * Parent skin object.
     *
     * @var object skin
     * @see __construct().
     */

    protected $skin;

    /**
     * Constructor.
     */

    public function __construct(Skin $skin = null)
    {
        parent::__construct();

        $this->setSkin($skin);
    }

    /**
     * {@inheritdoc}
     */

    public function setSkin(Skin $skin = null)
    {
        $this->skin = $skin === null ? \Txp::get('Textpattern\Skin\Skin')->setName() : $skin;

        return $this;
    }

    /**
     * $skin property getter.
     *
     * @return $this->skin The asset related skin object.
     */

    protected function getSkin()
    {
        return $this->skin;
    }

    /**
     * {@inheritdoc}
     */

    protected function getInfos($safe = false)
    {
        if ($safe) {
            $infoQuery = array();

            foreach ($this->infos as $col => $value) {
                if ($col === self::getFileContentsField()) {
                    $infoQuery[] = $col." = '".$value."'";
                } else {
                    $infoQuery[] = $col." = '".doSlash($value)."'";
                }
            }

            return implode(', ', $infoQuery);
        }

        return $this->infos;
    }

    /**
     * $fileContentsField property getter.
     *
     * @return string static::$fileContentsField.
     */

    protected static function getFileContentsField()
    {
        return static::$fileContentsField;
    }

    /**
     * Get essential templates infos from the $essential property value.
     *
     * @param  string $key      $essential property key for which you want to get the value.
     * @param  string $whereKey $essential property key to check against the $valueIn value.
     * @param  array  $valueIn  Values to check against the $whereKey values.
     * @return array            $essential property value if $key is null, filtered infos otherwise.
     */

    public static function getEssential(
        $key = null,
        $whereKey = null,
        $valueIn = null
    ) {
        if ($key === null) {
            return static::$essential;
        } elseif ($key === '*' && $whereKey) {
            $keyValues = array();

            foreach (static::$essential as $row) {
                if (in_array($row[$whereKey], $valueIn)) {
                    $keyValues[] = $row;
                }
            }
        } else {
            $key !== null or $key = 'name';
            $keyValues = array();

            foreach (static::$essential as $row) {
                if ($whereKey) {
                    if (in_array($row[$whereKey], $valueIn)) {
                        $keyValues[] = $row[$key];
                    }
                } else {
                    $keyValues[] = $row[$key];
                }
            }
        }

        return $keyValues;
    }

    /**
     * $dir property setter.
     */

    protected static function setDir($name)
    {
        static::$dir = $name;
    }

    /**
     * $dir property getter.
     *
     * @return string static::$dir.
     */

    public static function getDir()
    {
        return static::$dir;
    }

    /**
     * Gets the skin directory path.
     *
     * @return string path.
     */

    public function getDirPath()
    {
        return $this->getSkin()->getSubdirPath().DS.static::getDir();
    }

    /**
     * $subdirField property getter.
     */

    protected static function getSubdirField()
    {
        return static::$subdirField;
    }

    /**
     * $defaultSubdir property getter.
     */

    protected static function getDefaultSubdir()
    {
        return static::$defaultSubdir;
    }

    /**
     * $defaultSubdir property getter.
     */

    protected static function getSubdirValues()
    {
        return static::$subdirValues;
    }

    /**
     * Whether a subdirectory name is valid or not.
     *
     * @param  string $name Subdirectory name.
     * @return string       The subdirectory name if valid or the default subdirectory.
     */

    protected static function parseSubdir($name)
    {
        if (in_array($name, self::getSubdirValues())) {
            return $name;
        } else {
            return self::getDefaultSubdir();
        }
    }

    /**
     * {@inheritdoc}
     */

    protected function getSubdirPath($name = null)
    {
        $name or $name = $this->getInfos()[self::getSubdirField()];

        return $this->getDirPath().DS.$name;
    }

    /**
     * Get the template related file path.
     *
     * @param string path.
     */

    protected function getFilePath($name = null)
    {
        $dirPath = self::getSubdirField() ? $this->getSubdirPath($name) : $this->getDirPath();

        $name = $this->getName();
        $extension = pathinfo($name, PATHINFO_EXTENSION);

        return $dirPath.DS.$name.(isset(static::$mimeTypes[$extension]) ? '' : '.'.self::getExtension());
    }

    /**
     * {@inheritdoc}
     */

    public function getEditing()
    {
        $editing = get_pref('last_'.$this->getEvent().'_saved', '', true);
        $skin = $this->getSkin()->getName();
        $installed = $this->getInstalled() + array($skin => array(''));
        $installed = $installed[$skin];

        if (!$editing || !in_array($editing, $installed)) {
            reset($installed);
            $sliced = array_slice($installed, 0, 1);
            $editing = array_shift($sliced);

            $this->setEditing($editing);
        }

        return $editing;
    }

    /**
     * {@inheritdoc}
     */

    public function setEditing($name = null)
    {
        global $prefs;

        $event = $this->getEvent();
        $pref = 'last_'.$event.'_saved';
        $name !== null or $name = $this->getName();

        return set_pref($pref, $prefs[$pref] = $name, $event, PREF_HIDDEN, 'text_input', 0, PREF_PRIVATE);
    }

    /**
     * Set the skin_editing pref to the skin used by the default section.
     *
     * @return bool FALSE on error.
     */

    protected function resetEditing()
    {
        return $this->setEditing(self::getDefault());
    }

    /**
     * {@inheritdoc}
     */

    protected function createFile($path = null, $contents = null)
    {
        if ($path === null || $contents === null) {
            $infos = $this->getInfos();
        }

        if ($path === null) {
            $subdirField = $this->getSubdirField();
            $name = $this->getName();
            $extension = pathinfo($name, PATHINFO_EXTENSION);
            $file = $name.(isset(static::$mimeTypes[$extension]) ? '' : '.'.self::getExtension());

            if ($subdirField) {
                $path = $infos[$subdirField].DS.$file;
            } else {
                $path = $file;
            }
        }

        if ($contents === null) {
            $infos = $this->getInfos();
            $contents = $infos[self::getFileContentsField()];
        }

        return file_put_contents($this->getDirPath().DS.$path, $contents);
    }

    /**
     * {@inheritdoc}
     */

    public function createRows($rows = null)
    {
        $rows !== null or $rows = self::getEssential();

        $skin = $this->getSkin()->getName();
        $fields = array('skin', 'name');
        $fileContentsField = self::getFileContentsField();
        $subdirField = self::getSubdirField();
        $values = array();
        $update = "skin=VALUES(skin), name=VALUES(name), ";

        if ($subdirField) {
            $fields[] = $subdirField;

            foreach ($rows as $row) {
                $values[] = "('".doSlash($skin)."', "
                            ."'".doSlash($row['name'])."', "
                            ."'".doSlash($row[$subdirField])."', "
                            ."'".doSlash($row[$fileContentsField])."')";
            }

            $update .= $subdirField."=VALUES(".$subdirField."), ";
        } else {
            foreach ($rows as $row) {
                $values[] = "('".doSlash($skin)."', "
                            ."'".doSlash($row['name'])."', "
                            ."'".doSlash($row[$fileContentsField])."')";
            }
        }

        $fields[] = $fileContentsField;
        $update .= $fileContentsField."=VALUES(".$fileContentsField.")";

        return safe_query(
            "INSERT INTO ".safe_pfx($this->getTable())." (".implode(', ', $fields).") "
            ."VALUES ".implode(', ', $values)
            ." ON DUPLICATE KEY UPDATE ".$update
        );
    }

    /**
     * Delete obsolete template rows.
     *
     * @return bool FALSE on error.
     */

    protected function deleteExtraRows()
    {
        return $this->deleteRows(
            "skin = '".doSlash($this->getSkin()->getName())."' AND "
            ."name NOT IN ('".implode("', '", array_map('doSlash', $this->getNames()))."')"
        );
    }

    /**
     * {@inheritdoc}
     */

    protected function parseFiles($files)
    {
        $rows = $row = array();
        $subdirField = self::getSubdirField();
        $event = $this->getEvent();
        $extension = self::getExtension();

        $parsed = $parsedFiles = $names = array();

        if ($files) {
            $Skin = $this->getSkin();
            $skin = $Skin->getName();

            foreach ($files as $file) {
                $filename = $file->getFilename();
                $ext = pathinfo($filename, PATHINFO_EXTENSION);
                $name = $ext == $extension ? pathinfo($filename, PATHINFO_FILENAME) : $filename;

                if ($subdirField) {
                    $essentialSubdir = implode('', $this->getEssential($subdirField, 'name', array($name)));
                }

                if (in_array($filename, $parsedFiles)) {
                    $this->mergeResult($event.'_duplicate', array($skin => array($filename)));
                } elseif ($subdirField && $essentialSubdir && $essentialSubdir !== basename($file->getPath())) {
                    $this->mergeResult($event.'_subdir_error', array($skin => array(basename($file->getPath()).'/'.$name)));
                } else {
                    $names[] = $name;
                    $parsed[] = $row['name'] = $name;
                    $parsedFiles[] = $filename;

                    if ($subdirField) {
                        $subdir = basename($file->getPath());
                        $subdirValid = self::parseSubdir($subdir);

                        if ($subdir !== $subdirValid) {
                            $this->mergeResult($event.'_subdir_invalid', array($skin => array($subdir.'/'.$name)));
                        }

                        $row[$subdirField] = $subdirValid;
                    }

                    $row[self::getFileContentsField()] = $file->getContents();

                    $rows[] = $row;
                }
            }
        }

        $missingNames = array_diff(self::getEssential('name'), $parsed);

        $this->setNames(array_merge($names, $missingNames));

        $missingRows = self::getEssential('*', 'name', $missingNames);

        return array_merge($rows, $missingRows);
    }

    /**
     * Unlink obsolete template files.
     *
     * @param  array $not An array of template names to NOT unlink;
     * @return array      !Templates for which the unlink process FAILED!;
     */

    public function deleteExtraFiles($nameNotIn = null)
    {
        $filenames = array();
        $extension = self::getExtension();
        $hasSubdir = self::getSubdirField();
        $notRemoved = $subdirPaths = array();

        foreach ($this->getNames() as $name) {
            $ext = pathinfo($name, PATHINFO_EXTENSION);
            $filenames[] = $name.(isset(static::$mimeTypes[$ext]) ? '' : '.'.$extension);
        }

        $files = $this->getFiles($filenames, $hasSubdir ? 1 : 0);

        if ($files) {
            foreach ($files as $file) {
                $name = $file->getFilename();
                $ext = pathinfo($name, PATHINFO_EXTENSION);
                isset(static::$mimeTypes[$ext]) or $name = pathinfo($name, PATHINFO_FILENAME);

                $this->setName($name);

                if (!$nameNotIn || !in_array($name, $nameNotIn)) {
                    unlink($file->getPathname()) or $notRemoved[] = $name;

                    !$hasSubdir or $subdirPaths[] = $file->getPath();
                }
            }
        }

        if (!$notRemoved) {
            if ($hasSubdir) {
                foreach ($subdirPaths as $subdirPath) {
                    if (self::isDirEmpty($subdirPath) && !@rmdir($subdirPath)) {
                        $notRemoved[] = $subdirPath;
                    }
                }
            }

            $dirPath = $this->getDirPath();

            if (self::isDirEmpty($dirPath) && !@rmdir($dirPath)) {
                $notRemoved[] = $dirPath;
            }
        }

        return $notRemoved;
    }

    /**
     * {@inheritdoc}
     */

    public function import($sync = false, $override = false)
    {
        $event = $this->getEvent();
        $dirPath = $this->getDirPath();
        $Skin = $this->getSkin();
        $skin = $Skin !== null ? $Skin->getName() : $this->getSkin()->getEditing();
        $names = $this->getNames();
        $callbackExtra = compact('skin', 'names', 'sync');
        $done = array();
        $dirIsReadable = is_readable($dirPath);

        callback_event('txp.'.$event, 'import', 1, $callbackExtra);

        if ($dirIsReadable || !$override) {
            if ($dirIsReadable) {
                $filenames = array();
                $extension = self::getExtension();

                foreach ($names as $name) {
                    $ext = pathinfo($name, PATHINFO_EXTENSION);
                    $filenames[] = $name.(isset(static::$mimeTypes[$ext]) ? '' : '.'.$extension);
                }

                $files = $this->getFiles($filenames, self::getSubdirField() ? 1 : 0);

                if (!$files) {
                    $this->mergeResult($event.'_not_found', array($skin => array($dirPath)));
                }

                $rows = $this->parseFiles($files);
            } else {
                $this->mergeResult('path_not_readable', array($skin => array($dirPath)), 'warning');
                $rows = self::getEssential();
            }

            if (!$this->createRows($rows)) {
                $this->mergeResult($event.'_import_failed', array($skin => $names));
            } else {
                $done = array_column($rows, 'name');

                $this->mergeResult($event.'_imported', array($skin => $names), 'success');
            }

            // Drops extra rows…
            if ($sync) {
                if (!$this->deleteExtraRows()) {
                    $notCleaned = array_diff(array_column($this->getRows('name'), 'name'), $done);
                    $this->mergeResult($event.'_files_deletion_failed', array($skin => $notCleaned));
                }
            }
        }

        callback_event('txp.'.$event, 'import', 0, $callbackExtra + compact('done'));

        return $this;
    }

    /**
     * {@inheritdoc}
     */

    public function export($sync = false, $override = false)
    {
        $event = $this->getEvent();
        $dirPath = $this->getDirPath();
        $Skin = $this->getSkin();
        $skin = $Skin !== null ? $Skin->getName() : $this->getSkin()->getEditing();
        $names = $this->getNames();
        $callbackExtra = compact('skin', 'names', 'sync');
        $done = array();

        callback_event('txp.'.$event, 'export', 1, $callbackExtra);

        if (!is_writable($dirPath) && !@mkdir($dirPath)) {
            $this->mergeResult('path_not_writable', array($skin => array($dirPath)));
        } else {
            $rows = $this->getRows();

            if (!$rows) {
                $this->mergeResult($event.'_not_found', $skin, 'warning');
            } else {
                foreach ($rows as $row) {
                    extract($row);

                    if (!$this->setName($name)->isInstalled()) {
                        $this->mergeResult($event.'_unknown', array($skin => array($name)));
                    } elseif (!self::isExportable()) {
                        $this->mergeResult($event.'_name_unsafe', array($skin => array($name)));
                    } else {
                        $ready = true;
                        $subdirField = self::getSubdirField();
                        $contentsField = self::getFileContentsField();

                        if ($subdirField) {
                            $subdirPath = $this->setInfos($name, $$subdirField, $$contentsField)->getSubdirPath();

                            if (!is_dir($subdirPath) && !@mkdir($subdirPath)) {
                                $this->mergeResult($event.'_not_writable', array($skin => array($name)));
                                $ready = false;
                            }
                        } else {
                            $this->setInfos($name, $$contentsField);
                        }

                        if ($ready) {
                            if ($this->createFile() === false) {
                                $this->mergeResult($event.'_export_failed', array($skin => array($name)));
                            } else {
                                $this->mergeResult($event.'_exported', array($skin => array($name)), 'success');

                                $done[] = $name;
                            }
                        }
                    }
                }
            }

            // Drops extra files…
            if ($sync) {
                $notUnlinked = $this->deleteExtraFiles($done);

                if ($notUnlinked) {
                    $this->mergeResult($event.'_files_deletion_failed', array($skin => $notUnlinked));
                }
            }
        }

        callback_event('txp.'.$event, 'export', 0, $callbackExtra + compact('done'));

        return $this;
    }

    /**
     * {@inheritdoc}
     */

    public function getSelectEdit()
    {
        $event = $this->getEvent();
        $Skin = $this->getSkin();
        $skins = $Skin->getInstalled();

        if (count($skins) > 1) {
            return form(
                inputLabel(
                    'skin',
                    selectInput('skin', $skins, $Skin->getEditing(), false, 1, 'skin'),
                    'skin'
                )
                .eInput($event)
                .sInput($event.'_skin_change'),
                '',
                '',
                'post'
            );
        }

        return;
    }

    /**
     * Select the asset related skin to edit.
     * Keeps track from panel to panel.
     *
     * @param  string $skin Optional skin name. Read from GET/POST otherwise
     * @return object $this The current class object (chainable).
     */

    public function selectEdit($skin = null)
    {
        if ($skin === null) {
            $skin = gps('skin');
        }

        if ($skin) {
            $Skin = $this->getSkin();
            $Skin->setEditing($skin);
            $Skin->setName($skin);
        }

        $this->getEditing();

        return $this;
    }
}