<?php

/*
 * Copyright (C) 2023-2026 Deciso B.V.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

namespace OPNsense\Core;

class File
{
    /**
     * file_put_contents wrapper which sets permissions before writing data.
     * @param string $filename Path to the file where to write the data.
     * @param mixed $data The data to write.
     * @param int $permissions permissions to set, see chmod for usage
     * @param int $flags flags to pass to file_put_contents()
     * @param string $chown username to chown to
     * @return int|false
     */
    public static function file_put_contents(
        string $filename,
        mixed $data,
        int $permissions = 0640,
        int $flags = 0,
        ?string $chown = null
    ) {
        @touch($filename);
        @chmod($filename, $permissions);
        if (!empty($chown)) {
            $parts = explode(':', $chown);
            @chown($filename, $parts[0]);
            if (!empty($parts[1])) {
                @chgrp($filename, $parts[1]);
            }
        }
        return file_put_contents($filename, $data, $flags);
    }

    /**
     * file_put_contents wrapper which sets permissions before writing data if contents have changed.
     * @param string $filename Path to the file where to write the data.
     * @param mixed $data The data to write.
     * @param int $permissions permissions to set, see chmod for usage
     * @param int $flags flags to pass to file_put_contents()
     * @param string $chown username to chown to
     * @return int|false
     */
    public static function file_update_contents(
        string $filename,
        mixed $data,
        int $permissions = 0640,
        int $flags = 0,
        ?string $chown = null
    ) {
        if (!file_exists($filename) || hash('sha256', $data) !== hash_file('sha256', $filename)) {
            return self::file_put_contents($filename, $data, $permissions, $flags, $chown);
        } else {
            /* size "written" (already on disk) */
            return strlen($data);
        }
    }
}
