# script_zencart_desc()
sub script_zencart_desc
{
return "Zen Cart";
}

sub script_zencart_uses
{
return ( "php" );
}

sub script_zencart_longdesc
{
return "Zen Cart is a full-function e-commerce application for your website";
}

# script_zencart_versions()
sub script_zencart_versions
{
return ( "1.5.7c" );
}

sub script_zencart_can_upgrade
{
return 0;
}

sub script_zencart_release
{
return 3;	# Fix download URL map
}

sub script_zencart_category
{
return "Commerce";
}

sub script_zencart_php_vers
{
return ( 5 );
}

sub script_zencart_php_fullver
{
local ($d, $ver, $sinfo) = @_;
return "5.6";
}

sub script_zencart_php_modules
{
return ( "mysql", "curl", "intl", "gd", "zip",
         "bcmath", "iconv", "mbstring", "fileinfo" );
}

sub script_zencart_php_vars
{
return ( [ 'memory_limit', '256M', '+' ],
         [ 'post_max_size', '16M', '+' ],
         [ 'upload_max_filesize', '16M', '+' ],
         [ 'allow_url_fopen', 1 ] );
}

sub script_zencart_dbs
{
return ("mysql");
}

# script_zencart_params(&domain, version, &upgrade-info)
# Returns HTML for table rows for options for installing ZenCart
sub script_zencart_params
{
local ($d, $ver, $upgrade) = @_;
local $rv;
local $hdir = &public_html_dir($d, 1);
if ($upgrade) {
	# Options are fixed when upgrading
	local $dir = $upgrade->{'opts'}->{'dir'};
	$dir =~ s/^$d->{'home'}\///;
	$rv .= &ui_table_row("Install directory", $dir);
	}
else {
	# Show editable install options
	local @dbs = &domain_databases($d, [ "mysql" ]);
	$rv .= &ui_table_row("Database for Zen Cart tables",
		     &ui_database_select("db", undef, \@dbs, $d, "zencart"));
	$rv .= &ui_table_row("Install sub-directory under <tt>$hdir</tt>",
			     &ui_opt_textbox("dir", &substitute_scriptname_template("zencart", $d), 30, "At top level"));
	}
return $rv;
}

# script_zencart_parse(&domain, version, &in, &upgrade-info)
# Returns either a hash ref of parsed options, or an error string
sub script_zencart_parse
{
local ($d, $ver, $in, $upgrade) = @_;
if ($upgrade) {
	# Options are always the same
	return $upgrade->{'opts'};
	}
else {
	local $hdir = &public_html_dir($d, 0);
	$in{'dir_def'} || $in{'dir'} =~ /\S/ && $in{'dir'} !~ /\.\./ ||
		return "Missing or invalid installation directory";
	local $dir = $in{'dir_def'} ? $hdir : "$hdir/$in{'dir'}";
	local ($newdb) = ($in->{'db'} =~ s/^\*//);
	return { 'db' => $in->{'db'},
		 'newdb' => $newdb,
		 'dir' => $dir,
		 'path' => $in{'dir_def'} ? "/" : "/$in{'dir'}", };
	}
}

# script_zencart_check(&domain, version, &opts, &upgrade-info)
# Returns an error message if a required option is missing or invalid
sub script_zencart_check
{
local ($d, $ver, $opts, $upgrade) = @_;
$opts->{'dir'} =~ /^\// || return "Missing or invalid install directory";
$opts->{'db'} || return "Missing database";
if (-r "$opts->{'dir'}/includes/configure.php") {
	return "Zen Cart appears to be already installed in the selected directory";
	}
return undef;
}

# script_zencart_files(&domain, version, &opts, &upgrade-info)
# Returns a list of files needed by Zencart, each of which is a hash ref
# containing a name, filename and URL
sub script_zencart_files
{
local ($d, $ver, $opts, $upgrade) = @_;
local %vmap = ( "1.5.5f" => "12312017b",
		"1.5.6a" => "01042019",
		"1.5.6c" => "07162019",
		"1.5.7b" => "11232020",
		"1.5.7c" => "03052021",
	      );
local $source = { 'name' => "source",
		  'file' => "zen-cart-v$ver-full-fileset.zip",
		  'url' => "http://downloads.sourceforge.net/zencart/zen-cart-v$ver-$vmap{$ver}.zip",
		};
local @files = ( $source );
return @files;
}

sub script_zencart_commands
{
return ("unzip");
}

# script_zencart_install(&domain, version, &opts, &files, &upgrade-info)
# Actually installs ZenCart, and returns either 1 and an informational
# message, or 0 and an error
sub script_zencart_install
{
local ($d, $version, $opts, $files, $upgrade) = @_;
local ($out, $ex);

if ($opts->{'newdb'} && !$upgrade) {
	local $err = &create_script_database($d, $opts->{'db'});
	return (0, "Database creation failed : $err") if ($err);
	}
local ($dbtype, $dbname) = split(/_/, $opts->{'db'}, 2);
local $dbuser = &mysql_user($d);
local $dbpass = &mysql_pass($d);
local $dbhost = &get_database_host($dbtype, $d);
local $dberr = &check_script_db_connection($dbtype, $dbname, $dbuser, $dbpass);
return (0, "Database connection failed : $dberr") if ($dberr);

# Extract tar file to temp dir and copy to target
local $temp = &transname();
local $err = &extract_script_archive($files->{'source'}, $temp, $d,
	$opts->{'dir'}, "zen-cart-v*-*/");
$err && return (0, "Failed to extract source : $err");

# Set write permissions on needed files
local $dir;
foreach $dir ("cache", "pub", "images", "logs", "media",
	    "includes/languages/english/html_includes", "admin/backups",
	    "admin/images/graphs",
	    "admin/includes", "includes") {
	&make_file_php_writable($d, "$opts->{'dir'}/$dir");
	}

# If it was manually force upgraded using Manage Script page
if ($upgrade) {
	&unlink_file_as_domain_user($d, "$opts->{'dir'}/includes/dist-configure.php");
	&unlink_file_as_domain_user($d, "$opts->{'dir'}/admin");
	&unlink_file_as_domain_user($d, "$opts->{'dir'}/zc_install");
	}
else {
	&copy_source_dest("$opts->{'dir'}/includes/dist-configure.php", "$opts->{'dir'}/includes/configure.php");
	&copy_source_dest("$opts->{'dir'}/admin/includes/dist-configure.php", "$opts->{'dir'}/admin/includes/configure.php");
	&make_file_php_writable($d, "$opts->{'dir'}/admin/includes/configure.php");
	}
&unlink_file_as_domain_user($d, "$opts->{'dir'}/includes/dist-configure.php");
&unlink_file_as_domain_user($d, "$opts->{'dir'}/admin/includes/dist-configure.php");

&make_file_php_writable($d, "$opts->{'dir'}/includes/configure.php");

# Return a URL for the user
local $url = &script_path_url($d, $opts);
my $install = $upgrade ? "" : "zc_install/index.php";
my $msg0 = $upgrade ? "Basic file upgrade operation for Zen Cart complete." : "Go to <a target=_blank href='${url}$install'>$url</a> to complete the Zen Cart installation process";
my $msg1 = $upgrade ? "<br>Recommended reading <a target=_blank href='https://docs.zen-cart.com/user/upgrading/'>official manual</a> after upgrading.<br><br>" : "<br>For filling database credentials use for host <tt>$dbhost</tt>, for name <tt>$dbname</tt>, for user <tt>$dbuser</tt> and for password use <tt>$dbpass</tt>.<br><br>";
local $rp = $opts->{'dir'};
$rp =~ s/^$d->{'home'}\///;
return (1, "$msg0.$msg1", "Under $rp", $url);
}

# script_zencart_uninstall(&domain, version, &opts)
# Un-installs a Zencart installation, by deleting the directory and database.
# Returns 1 on success and a message, or 0 on failure and an error
sub script_zencart_uninstall
{
local ($d, $version, $opts) = @_;

# Remove the contents of the target directory
local $derr = &delete_script_install_directory($d, $opts);
return (0, $derr) if ($derr);

# Take out the DB
if ($opts->{'newdb'}) {
	&cleanup_script_database($d, $opts->{'db'}, '(.*)');
	&delete_script_database($d, $opts->{'db'});
	}

return (1, "Deleted Zen Cart directory and database.");
}

# script_zencart_check_latest(version)
# Checks if some version is the latest for this project, and if not returns
# a newer one. Otherwise returns undef.
sub script_zencart_check_latest
{
local ($ver) = @_;
local @vers = &osdn_package_versions(
	"zencart", $ver < 1.5 ?
		"zen-cart-v(1\\.3\\.[0-9\\.]+[a-z]?)-(full-fileset-)?\\d+\\.zip" :
		"zen-cart-v([0-9\\.]+[a-z]?)-(full-fileset-)?\\d+\\.zip");
return "Failed to find versions" if (!@vers);
return $ver eq $vers[0] ? undef : $vers[0];
}

sub script_zencart_site
{
return 'http://www.zencart.com/';
}

1;