File: //usr/share/webmin/virtual-server/scripts/tikiwiki.pl
# script_tikiwiki_desc()
sub script_tikiwiki_desc
{
return "Tiki Wiki CMS Groupware";
}
sub script_tikiwiki_uses
{
return ( "php" );
}
sub script_tikiwiki_longdesc
{
return "A full featured free software Wiki/CMS/Groupware written in PHP";
}
# script_tikiwiki_versions()
sub script_tikiwiki_versions
{
return ( "28.4", "27.3", "24.9" );
}
sub script_tikiwiki_release
{
return 1; # Fix installer and rename htpasswd file
}
sub script_tikiwiki_testable
{
return 1;
}
sub script_tikiwiki_category
{
return "Wiki";
}
sub script_tikiwiki_php_vers
{
local ($d, $ver) = @_;
return ( 5 );
}
sub script_tikiwiki_php_modules
{
return ("mysql", "xml", "intl", "zip", "gd", "mbstring");
}
sub script_tikiwiki_dbs
{
return ("mysql");
}
# script_tikiwiki_php_fullver(&domain, version, &sinfo)
# Returns the PHP version to use for this script, or undef if it is not supported
sub script_tikiwiki_php_fullver
{
local ($d, $ver, $sinfo) = @_;
return &compare_versions($ver, 17) <= 0 ? undef :
&compare_versions($ver, 22) <= 0 ? "7.2" :
&compare_versions($ver, 25) <= 0 ? "7.4" : "8.1";
}
sub script_tikiwiki_can_upgrade
{
return 1;
}
sub script_tikiwiki_php_vars
{
return ( [ 'memory_limit', '128M', '+' ] );
}
# script_tikiwiki_params(&domain, version, &upgrade-info)
# Returns HTML for table rows for options for installing TikiWiki
sub script_tikiwiki_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 TikiWiki 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 TikiWiki tables",
&ui_database_select("db", undef, \@dbs, $d, "tikiwiki"));
$rv .= &ui_table_row("Install sub-directory under <tt>$hdir</tt>",
&ui_opt_textbox("dir", &substitute_scriptname_template("tikiwiki", $d), 30, "At top level"));
$rv .= &ui_table_row("Setup automatically",
&ui_radio("install", 'y', [ [ "n", "No" ], [ "y", "Yes" ]]));
}
return $rv;
}
# script_tikiwiki_parse(&domain, version, &in, &upgrade-info)
# Returns either a hash ref of parsed options, or an error string
sub script_tikiwiki_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/^\*//);
my $password = &virtual_server::random_password(8);
return { 'db' => $in->{'db'},
'newdb' => $newdb,
'dir' => $dir,
'path' => $in{'dir_def'} ? "/" : "/$in{'dir'}",
'install' => $in{'install'},
'password' => $password };
}
}
# script_tikiwiki_check(&domain, version, &opts, &upgrade-info)
# Returns an error message if a required option is missing or invalid
sub script_tikiwiki_check
{
local ($d, $ver, $opts, $upgrade) = @_;
$opts->{'dir'} =~ /^\// || return "Missing or invalid install directory";
if (-r "$opts->{'dir'}/tiki-install.php") {
return "TikiWiki appears to be already installed in the selected directory";
}
local ($dbtype, $dbname) = split(/_/, $opts->{'db'}, 2);
local $clash = &find_database_table($dbtype, $dbname, "tiki_.*");
$clash && return "TikiWiki appears to be already using the selected database (table $clash)";
return undef;
}
# script_tikiwiki_files(&domain, version, &opts, &upgrade-info)
# Returns a list of files needed by TikiWiki, each of which is a hash ref
# containing a name, filename and URL
sub script_tikiwiki_files
{
local ($d, $ver, $opts, $upgrade) = @_;
local @files = ( { 'name' => "source",
'file' => "tikiwiki-$ver.zip",
'url' => "http://osdn.dl.sourceforge.net/sourceforge/tikiwiki/tiki-$ver.zip" } );
return @files;
}
sub script_tikiwiki_commands
{
return ("unzip");
}
# script_tikiwiki_install(&domain, version, &opts, &files, &upgrade-info)
# Actually installs PhpWiki, and returns either 1 and an informational
# message, or 0 and an error
sub script_tikiwiki_install
{
local ($d, $version, $opts, $files, $upgrade) = @_;
local ($out, $ex);
if ($opts->{'newdb'} && !$upgrade) {
local $dbopts = { 'charset' => 'utf8' };
local $err = &create_script_database($d, $opts->{'db'}, $dbopts);
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($d, $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'}, "tiki-$ver");
$err && return (0, "Failed to extract source : $err");
local $cfile = "$opts->{'dir'}/db/local.php";
my $post_install = $opts->{'install'} == 'y';
if (!$upgrade) {
# Create the config file
&open_tempfile_as_domain_user($d, CONFIG, ">$cfile");
&print_tempfile(CONFIG,
"<?php\n".
"\$db_tiki = 'mysql';\n".
"\$dbversion_tiki = '$version';\n".
"\$host_tiki = '$dbhost';\n".
"\$user_tiki = '$dbuser';\n".
"\$pass_tiki = '$dbpass';\n".
"\$dbs_tiki = '$dbname';\n".
"\$client_charset = 'utf8mb4';\n"
);
&close_tempfile_as_domain_user($d, CONFIG);
# Setup instance
if ($post_install) {
&tikiwiki_postinstallation($d, undef, $opts);
}
# Rename _htaccess to .htaccess
if (&domain_has_website($d) eq 'web') {
&run_as_domain_user(
$d, "mv $opts->{'dir'}/_htaccess $opts->{'dir'}/.htaccess");
}
} else {
&tikiwiki_postinstallation($d, $upgrade, $opts);
}
my $password = $opts->{'password'};
if (! $post_install && !$upgrade) {
# Delete install lock file
&unlink_file_as_domain_user($d, "$opts->{'dir'}/db/lock");
$password = "";
}
local $url = &script_path_url($d, $opts);
local $adminurl = $url.($post_install ? "" : "tiki-install.php");
local $rp = $opts->{'dir'};
$rp =~ s/^$d->{'home'}\///;
if ($upgrade) {
return (1, "Initial TikiWiki upgrade complete. Go to <a target=_blank href='$adminurl'>$adminurl</a> to complete the upgrade process.", "Under $rp using $dbtype database $dbname", $url, "admin", "$password");
}
else {
return (1, "Initial TikiWiki installation complete. Go to <a target=_blank href='$adminurl'>$adminurl</a> to finish installing it.", "Under $rp using $dbtype database $dbname", $url, "admin", "$password");
}
}
# script_tikiwiki_uninstall(&domain, version, &opts)
# Un-installs a TikiWiki installation, by deleting the directory and database.
# Returns 1 on success and a message, or 0 on failure and an error
sub script_tikiwiki_uninstall
{
local ($d, $version, $opts) = @_;
# Remove phpbb tables from the database
&cleanup_script_database($d, $opts->{'db'},
"(tiki_|galaxia_|messu_|sessions|users_|metrics_)");
# 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'}) {
&delete_script_database($d, $opts->{'db'});
}
if ($dbtype) {
return (1, "TikiWiki directory and tables deleted.");
}
else {
return (1, "TikiWiki directory deleted.");
}
}
sub script_tikiwiki_db_conn_desc
{
my $db_conn_desc =
{ 'db/local.php' =>
{
'dbpass' =>
{
'func' => 'php_quotemeta',
'func_params' => 1,
'replace' => [ '\$pass_tiki\s*=' =>
'$pass_tiki = \'$$sdbpass\';' ],
},
'dbuser' =>
{
'replace' => [ '\$user_tiki\s*=' =>
'$user_tiki = \'$$sdbuser\';' ],
},
}
};
return $db_conn_desc;
}
# script_tikiwiki_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_tikiwiki_check_latest
{
local ($ver) = @_;
local @vers;
if ($ver >= 28) {
@vers = &osdn_package_versions("tikiwiki/Tiki_28.x_Castor",
"tiki-(28\.[0-9\\.]+)\\.zip");
}
elsif ($ver >= 27) {
@vers = &osdn_package_versions("tikiwiki/Tiki_27.x_Miaplacidus",
"tiki-(27\.[0-9\\.]+)\\.zip");
}
elsif ($ver >= 26) {
@vers = &osdn_package_versions("tikiwiki/Tiki_26.x_Alnilam",
"tiki-(26\.[0-9\\.]+)\\.zip");
}
elsif ($ver >= 25) {
@vers = &osdn_package_versions("tikiwiki/Tiki_25.x_Sagittarius_A",
"tiki-(25\.[0-9\\.]+)\\.zip");
}
elsif ($ver >= 24) {
@vers = &osdn_package_versions("tikiwiki/Tiki_24.x_Wolf_359",
"tiki-(24\.[0-9\\.]+)\\.zip");
}
elsif ($ver >= 21) {
@vers = &osdn_package_versions("tikiwiki/Tiki_21.x_UY_Scuti",
"tiki-(21\.[0-9\\.]+)\\.zip");
}
elsif ($ver >= 18) {
@vers = &osdn_package_versions("tikiwiki/Tiki_18.x_Alcyone",
"tiki-(18\.[0-9\\.]+)\\.zip");
}
return "Failed to find versions" if (!@vers);
return $ver eq $vers[0] ? undef : $vers[0];
}
sub script_tikiwiki_site
{
return 'http://tiki.org/';
}
# tikiwiki_postinstallation(&domain,upgrade, &opts)
# setup instance configuration after an fresh installation or an upgrade.
sub tikiwiki_postinstallation
{
local ($d, $upgrade, $opts) = @_;
my $dom_php_bin = &get_php_cli_command($opts->{'phpver'}) || &has_command("php");
$dom_php_bin || return (0, "Could not find PHP CLI command");
my $cmd_prefix = "$dom_php_bin $opts->{'dir'}/console.php";
my $email = $d->{'emailto'};
my $password = $opts->{'password'};
my @steps = (
["Installing database... [may take a while]", "-q database:install"],
["Setup user password", "users:password 'admin' '$password'"],
["Setup sender_email preference", "preferences:set 'sender_email' '$email'"]
);
# Instance datebase need to be update after an upgrade.
if ($upgrade) {
@steps = (
["Update database... [may take a while]", "database:update"]
);
}
push @steps, ["Rebuild index ", "index:rebuild"];
foreach my $step (@steps) {
my ($description, $command) = @$step;
print "$description<br>";
my $out = &run_as_domain_user($d, "$cmd_prefix $command 2>&1");
if ($?) {
return (-1, "\`tikiwiki $description \` failed : $out");
}
}
}
1;