# script_opencart_desc()
sub script_opencart_desc
{
return "OpenCart";
}

sub script_opencart_uses
{
return ( "php" );
}

sub script_opencart_longdesc
{
return "A powerful open-source shopping cart system that is designed to be feature rich and user friendly";
}

# script_opencart_versions()
sub script_opencart_versions
{
return ( "4.0.1.1", "3.0.3.8" );
}

sub script_opencart_release
{
return 3;	# Fix download URL
}

sub script_opencart_category
{
return "Commerce";
}

sub script_opencart_php_vers
{
return ( 5 );
}

sub script_opencart_php_modules
{
return ( "mysql", "curl", "gd", "mbstring", "xml" );
}

sub script_opencart_php_optional_modules
{
return ( "mcrypt" );
}

sub script_opencart_dbs
{
return ("mysql");
}

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

# script_opencart_php_vars(&domain)
# Returns an array of extra PHP variables needed for this script
sub script_opencart_php_vars
{
return ( [ 'magic_quotes_gpc', 'Off' ] );
}

# script_opencart_params(&domain, version, &upgrade-info)
# Returns HTML for table rows for options for installing Wordpress
sub script_opencart_params
{
local ($d, $ver, $upgrade) = @_;
local $rv;
local $hdir = &public_html_dir($d, 1);
if ($upgrade) {
	# Options are fixed when upgrading
	local ($dbtype, $dbname) = split(/_/, $upgrade->{'opts'}->{'db'}, 2);
	$rv .= &ui_table_row("Database for OpenCart tables", $dbname);
	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 OpenCart tables",
		     &ui_database_select("db", undef, \@dbs, $d, "opencart"));
	$rv .= &ui_table_row("Install sub-directory under <tt>$hdir</tt>",
			     &ui_opt_textbox("dir", &substitute_scriptname_template("opencart", $d), 30, "At top level"));
	}
return $rv;
}

# script_opencart_parse(&domain, version, &in, &upgrade-info)
# Returns either a hash ref of parsed options, or an error string
sub script_opencart_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_opencart_check(&domain, version, &opts, &upgrade-info)
# Returns an error message if a required option is missing or invalid
sub script_opencart_check
{
local ($d, $ver, $opts, $upgrade) = @_;
$opts->{'dir'} =~ /^\// || return "Missing or invalid install directory";
$opts->{'db'} || return "Missing database";
if (-r "$opts->{'dir'}/config.php") {
	return "OpenCart appears to be already installed in the selected directory";
	}
local ($dbtype, $dbname) = split(/_/, $opts->{'db'}, 2);
local $clash = &find_database_table($dbtype, $dbname, "opencart_.*");
$clash && return "OpenCart appears to be already using the selected database (table $clash)";
return undef;
}

# script_opencart_files(&domain, version, &opts, &upgrade-info)
# Returns a list of files needed by Wordpress, each of which is a hash ref
# containing a name, filename and URL
sub script_opencart_files
{
local ($d, $ver, $opts, $upgrade) = @_;
local @files = ( { 'name' => "source",
	'file' => "${ver}-OpenCart.zip",
	'url' => "https://github.com/opencart/opencart/releases/download/${ver}/opencart-${ver}.zip" } );
return @files;
}

sub script_opencart_commands
{
return ("unzip");
}

# script_opencart_install(&domain, version, &opts, &files, &upgrade-info)
# Actually installs OpenCart, and returns either 1 and an informational
# message, or 0 and an error
sub script_opencart_install
{
local ($d, $version, $opts, $files, $upgrade, $domuser, $dompass) = @_;
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("mysql", $d);
local $dberr = &check_script_db_connection($dbtype, $dbname, $dbuser, $dbpass);
return (0, "Database connection failed : $dberr") if ($dberr);

# Backup config file
local $cfile = "$opts->{'dir'}/config.php";
local $admin_cfile = "$opts->{'dir'}/admin/config.php";
local $cfile_temp = &transname();
local $admin_cfile_temp = &transname();
if ($upgrade) {
	&copy_source_dest($cfile, $cfile_temp);
	&copy_source_dest($admin_cfile, $admin_cfile_temp);
	}

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

# Put back config files
if ($upgrade) {
	&copy_source_dest_as_domain_user($d, $cfile_temp, $cfile);
	&copy_source_dest_as_domain_user($d, $admin_cfile_temp, $admin_cfile);
	}

# Make important files writeable
&make_file_php_writable($d, "$opts->{'dir'}/image", 1);
&make_file_php_writable($d, "$opts->{'dir'}/image/cache", 1);
&make_file_php_writable($d, "$opts->{'dir'}/image/data", 1);
&make_file_php_writable($d, "$opts->{'dir'}/system/cache", 1);
&make_file_php_writable($d, "$opts->{'dir'}/system/logs", 1);
&make_file_php_writable($d, "$opts->{'dir'}/download", 1);
if (!-r "$opts->{'dir'}/config.php") {
	&copy_source_dest_as_domain_user($d,
		"$opts->{'dir'}/config-dist.php",
		"$opts->{'dir'}/config.php");
	}
&make_file_php_writable($d, "$opts->{'dir'}/config.php", 0);
if (!-r "$opts->{'dir'}/admin/config.php") {
	&copy_source_dest_as_domain_user($d,
		"$opts->{'dir'}/admin/config-dist.php",
		"$opts->{'dir'}/admin/config.php");
	}
&make_file_php_writable($d, "$opts->{'dir'}/admin/config.php", 0);

if (!$upgrade) {
	# Call the DB setup page
	local @params = (
		[ "db_driver", "mysqli" ],
		[ "db_hostname", $dbhost ],
		[ "db_username", $dbuser ],
		[ "db_password", $dbpass ],
		[ "db_database", $dbname ],
		[ "db_port", 3306 ],
		[ "db_prefix", "opencart_" ],
		[ "username", $domuser ],
		[ "password", $dompass ],
		[ "email", $d->{'emailto'} ],
		);
	local $params = join("&", map { $_->[0]."=".&urlize($_->[1]) } @params);
	local $ipage = $opts->{'path'}."/install/index.php?route=install/step_3";
	local ($out, $error);
	&post_http_connection($d, $ipage, $params, \$out, \$error);
	if ($error !~ /Location\s+header.*install\/step_4/) {
		if ($error) {
			return (-1, "Database setup failed : $error");
			}
		elsif ($out !~ /Congratulations|Installation\s+complete/) {
			return (-1, "Database setup failed");
			}
		}
	}

# Delete the install dir
&unlink_file_as_domain_user($d, "$opts->{'dir'}/install");

# Return a URL for the user
local $url = &script_path_url($d, $opts);
local $rp = $opts->{'dir'};
$rp =~ s/^$d->{'home'}\///;
local $adminurl = $url."admin";
return (1, "OpenCart installation complete. It can be managed at <a target=_blank href='$adminurl'>$adminurl</a> .", "Under $rp using $dbphptype database $dbname", $url, $domuser, $dompass);
}

# script_opencart_uninstall(&domain, version, &opts)
# Un-installs a Wordpress installation, by deleting the directory and database.
# Returns 1 on success and a message, or 0 on failure and an error
sub script_opencart_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);

# Remove all opencart_ tables from the database
&cleanup_script_database($d, $opts->{'db'}, "(opencart_|oc_)");

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

return (1, "OpenCart directory and tables deleted.");
}

# script_opencart_latest(version)
# Returns a URL and regular expression or callback func to get the version
sub script_opencart_latest
{
local ($ver) = @_;
return ( "https://www.opencart.com/index.php?route=cms/download",
	 ">v([0-9]+\\.[0-9\\.]+) " );
}

sub script_opencart_site
{
return 'http://www.opencart.com/';
}

sub script_opencart_passmode
{
return 1;
}

1;