source: branches/1.1dev/bin/module_maker/module.cli.php @ 79

#!/usr/local/bin/php
<?php
/**
 * module.cli.php
 * Code by Strangecode :: www.strangecode.com :: This document contains copyrighted information
 */


// Get module maker configuration.
require_once dirname(__FILE__) . '/_config.inc.php';


/******************************************************************************
 * CONFIG
 *****************************************************************************/

// Test for a single argument.
if ($_SERVER['argc'] == 5 && $_SERVER['argv'][4] == 'clean') {
    $module_name_singular = $_SERVER['argv'][2];
    $module_name_plural = $_SERVER['argv'][3];
} else if ($_SERVER['argc'] == 4) {
    // Normal operation.
    $module_name_singular = $_SERVER['argv'][2];
    $module_name_plural = $_SERVER['argv'][3];
} else if ($_SERVER['argc'] == 3 && $_SERVER['argv'][2] == '_default_') {
    // Hacked mode: use these module names:
    $module_name_singular = 'event';
    $module_name_plural = 'events';
    echo "Notice: using hacked module names.\n";
} else {
    die(basename($_SERVER['argv'][0]) . " Error: invalid arguments. Try like this:
    
    " . basename($_SERVER['argv'][0]) . " <sitedirectory> <namesingular> <nameplural>
    
E.g.: " . basename($_SERVER['argv'][0]) . " ~/Sites/www.asdf.com category categories

There is also a secret _default_ option that uses options hard-coded into the script. Hack the script for more info.
The following files will be generated by this script:
/admin/nameplural.php
/admin/_templates/namesingular_list.ihtml
/admin/_templates/namesingular_form.ihtml
/html/nameplural.php
/html/_templates/namesingular_list.ihtml
/html/_templates/namesingular.ihtml

");
}

// Where deleted files go:
$user_trash_folder = $_SERVER['HOME'] . '/.Trash';

// Directories
$skel_dir = realpath(CODE_BASE . '/bin/module_maker/skel');
$admin_dir = realpath(CODE_BASE . '/../admin');
$admin_tpl_dir = realpath(CODE_BASE . '/../admin/_templates');
$public_dir = realpath(CODE_BASE . '/../html');
$public_tpl_dir = realpath(CODE_BASE . '/../html/_templates');

// Names
$module_title = ucwords($module_name_plural);
$item_title = ucwords($module_name_singular);
$module_name_upper = strtoupper($module_name_plural);

// Admin files
$admin_script = $module_name_plural . '.php';
$admin_list_template = $module_name_singular . '_list.ihtml';
$admin_form_template = $module_name_singular . '_form.ihtml';

// Public files
$public_script = $module_name_plural . '.php';
$public_list_template = $module_name_singular . '_list.ihtml';
$public_detail_template = $module_name_singular . '.ihtml';

// Databaes names
$db_tbl = $module_name_singular . '_tbl';
$primary_key = $module_name_singular . '_id';


// Only after we've defined essential files can we clean.
if ($_SERVER['argc'] == 5 && $_SERVER['argv'][4] == 'clean') {
    echo "Beginning file cleanup\n";
    trashFile("$admin_dir/$admin_script");
    trashFile("$admin_tpl_dir/$admin_list_template");
    trashFile("$admin_tpl_dir/$admin_form_template");
    trashFile("$public_dir/$public_script");
    trashFile("$public_tpl_dir/$public_list_template");
    trashFile("$public_tpl_dir/$public_detail_template");
    echo "End file cleanup\n";
    die;
}

// Go!
echo 'Running Module Maker. Using database: ' . $CFG->database . "\n";


/******************************************************************************
 * PREPROCESSING
 *****************************************************************************/

// Ensure skel files exist.
if (
    !file_exists("$skel_dir/admin.php") ||
    !file_exists("$skel_dir/public.php") ||
    !file_exists("$skel_dir/public.ihtml") ||
    !file_exists("$skel_dir/public_list.ihtml")
) {
    die(basename($_SERVER['argv'][0]) . " Warning: one or more skeleton source files missing. Please check $skel_dir.\n");
}

// Ensure essential directories exist.
if (!is_dir("$admin_dir")) {
    die(basename($_SERVER['argv'][0]) . " Error: $admin_dir directory not found.\n");
}
if (!is_dir("$admin_tpl_dir")) {
    die(basename($_SERVER['argv'][0]) . " Error: $admin_tpl_dir directory not found.\n");
}
if (!is_dir("$public_dir")) {
    die(basename($_SERVER['argv'][0]) . " Error: $public_dir directory not found.\n");
}
if (!is_dir("$public_tpl_dir")) {
    die(basename($_SERVER['argv'][0]) . " Error: $public_tpl_dir directory not found.\n");
}

// Get DB tables.
$qid = dbQuery("SHOW TABLES");
while (list($row) = mysql_fetch_row($qid)) {
    $tables[] = $row;
}

// Make sure requested table is in database.
if (!in_array($db_tbl, $tables)) {
    die(basename($_SERVER['argv'][0]) . " Warning: $db_tbl does not exist in database $CFG->database. Please select one of: \n\n" . join("\n", $tables) . "\n\n");
}

// Ensure requested table contains columns.
// Get DB table column info.
$qid = dbQuery("DESCRIBE " . addslashes($db_tbl));
while ($row = mysql_fetch_row($qid)) {
    $cols[] = $row;
}
if (!is_array($cols) || empty($cols)) {
    die(basename($_SERVER['argv'][0]) . " Warning: $db_tbl does not have any columns.\n");
}


/******************************************************************************
 * SETUP VARIABLES
 *****************************************************************************/


// Loop through columns
$multipart_form_required = false;
$headers = array();
$public_list_page_vars = array();
$public_detail_page_vars = array();
if (is_array($cols) && !empty($cols)) {
    foreach ($cols as $col) {
        
        // Human readable.
        $field = $col[0];
        $field_title = ucfirst(str_replace('_', ' ', $field));
        $type = preg_replace('/^(\w+).*$/', '\\1', $col[1]);
        
        // Get primary key.
//         if ('PRI' == $col[3]) {
//             $primary_key = $field;
//         }
        
        // Our form will require type="multipart/form-data".
        if (preg_match('/file/i', $field)) {
            $multipart_form_required = false;
        }
        
        // Column headers.
        $headers[$field] = $field_title;
        
        // Get php code for printing variables.
        $public_list_page_vars[] = "<\x3fphp echo oTxt(\$" . $module_name_singular . "_list[\$i]['$field']); \x3f>";
        $public_detail_page_vars[] = "<\x3fphp echo oTxt(\$item['$field']); \x3f>";
    }
}

// -------------FILES-------------

$skel_files['admin_script'] = file_get_contents($skel_dir . '/admin.php');
$skel_files['admin_list_template'] = file_get_contents($skel_dir . '/adm_list.ihtml');
$skel_files['admin_form_template'] = file_get_contents($skel_dir . '/adm_form.ihtml');
$skel_files['public_script'] = file_get_contents($skel_dir . '/public.php');
$skel_files['public_list_template'] = file_get_contents($skel_dir . '/public_list.ihtml');
$skel_files['public_detail_template'] = file_get_contents($skel_dir . '/public.ihtml');


// -------------VARS-------------

// Simple...

$search['date'] = '/%DATE%/';
$replace['date'] = date($CFG->date_format);

$search['name_plural'] = '/%NAME_PLURAL%/';
$replace['name_plural'] = $module_name_plural;

$search['name_singular'] = '/%NAME_SINGULAR%/';
$replace['name_singular'] = $module_name_singular;

$search['title'] = '/%TITLE%/';
$replace['title'] = $module_title;

$search['item_title'] = '/%ITEM_TITLE%/';
$replace['item_title'] = $item_title;

$search['primary_key'] = '/%PRIMARY_KEY%/';
$replace['primary_key'] = $primary_key;

$search['db_tbl'] = '/%DB_TBL%/';
$replace['db_tbl'] = $db_tbl;

$search['name_upper'] = '/%NAME_UPPER%/';
$replace['name_upper'] = $module_name_upper;

$search['admin_script'] = '/%ADMIN_SCRIPT%/';
$replace['admin_script'] = $admin_script;

$search['admin_list_template'] = '/%ADMIN_LIST_TEMPLATE%/';
$replace['admin_list_template'] = $admin_list_template;

$search['admin_form_template'] = '/%ADMIN_FORM_TEMPLATE%/';
$replace['admin_form_template'] = $admin_form_template;

$search['public_script'] = '/%PUBLIC_SCRIPT%/';
$replace['public_script'] = $public_script;

$search['public_list_template'] = '/%PUBLIC_LIST_TEMPLATE%/';
$replace['public_list_template'] = $public_list_template;

$search['public_detail_template'] = '/%PUBLIC_DETAIL_TEMPLATE%/';
$replace['public_detail_template'] = $public_detail_template;

$search['public_detail_page_vars'] = '/%PUBLIC_DETAIL_PAGE_VARS%/';
$replace['public_detail_page_vars'] = join("\n", $public_detail_page_vars);

$search['public_list_page_vars'] = '/%PUBLIC_LIST_PAGE_VARS%/';
$replace['public_list_page_vars'] = join("\n", $public_list_page_vars);

$search['search_fields'] = '/%SEARCH_FIELDS%/';
$replace['search_fields'] = join(", ", $headers);

$search['admin_form_tag_init'] = '/%ADMIN_FORM_TAG_INIT%/';
if ($multipart_form_required) {
    $replace['admin_form_tag_init'] = "<form enctype=\"multipart/form-data\" method=\"post\" action=\"<\x3fphp echo \$_SERVER['PHP_SELF']; \x3f>\">\n<input type=\"hidden\" name=\"MAX_FILE_SIZE\" value=\"12000000\">";
} else {
    $replace['admin_form_tag_init'] = "<form method=\"post\" action=\"<\x3fphp echo \$_SERVER['PHP_SELF']; \x3f>\">";
}


// Complex....

echo "Generating admin form table rows...\n";
$output = array();
exec(dirname($_SERVER['argv'][0]) . "/form_template.cli.php $db_tbl", $output, $return_val);
if ($return_val == 0) {
    $search['adm_form_table_rows'] = '/%ADM_FORM_TABLE_ROWS%/';
    $replace['adm_form_table_rows'] = join("\n", $output);
} else {
    die(basename($_SERVER['argv'][0]) . " Error: could not execute form_template.cli.php.\n");
}

echo "Generating admin list table header rows...\n";
$output = array();
exec(dirname($_SERVER['argv'][0]) . "/list_template.cli.php $db_tbl headerrows", $output, $return_val);
if ($return_val == 0) {
    $search['adm_list_header_rows'] = '/%ADM_LIST_HEADER_ROWS%/';
    $replace['adm_list_header_rows'] = join("\n", $output);
} else {
    die(basename($_SERVER['argv'][0]) . " Error: could not execute list_template.cli.php.\n");
}

echo "Generating admin list table rows...\n";
$output = array();
exec(dirname($_SERVER['argv'][0]) . "/list_template.cli.php $db_tbl listrows", $output, $return_val);
if ($return_val == 0) {
    $search['adm_list_rows'] = '/%ADM_LIST_ROWS%/';
    $replace['adm_list_rows'] = join("\n", $output);
} else {
    die(basename($_SERVER['argv'][0]) . " Error: could not execute list_template.cli.php.\n");
}

echo "Generating sortorder...\n";
$output = array();
exec(dirname($_SERVER['argv'][0]) . "/sql.cli.php $db_tbl sortorder", $output, $return_val);
if ($return_val == 0) {
    $search['sort_order'] = '/%SORT_ORDER%/';
    $replace['sort_order'] = join("\n", $output);
} else {
    die(basename($_SERVER['argv'][0]) . " Error: could not execute sql.cli.php.\n");
}

echo "Generating insert data...\n";
$output = array();
exec(dirname($_SERVER['argv'][0]) . "/sql.cli.php $db_tbl insert", $output, $return_val);
if ($return_val == 0) {
    $search['insert'] = '/%INSERT%/';
    $replace['insert'] = join("\n", $output);
} else {
    die(basename($_SERVER['argv'][0]) . " Error: could not execute sql.cli.php.\n");
}

echo "Generating update data...\n";
$output = array();
exec(dirname($_SERVER['argv'][0]) . "/sql.cli.php $db_tbl update", $output, $return_val);
if ($return_val == 0) {
    $search['update'] = '/%UPDATE%/';
    $replace['update'] = join("\n", $output);
} else {
    die(basename($_SERVER['argv'][0]) . " Error: could not execute sql.cli.php.\n");
}

echo "Generating search data...\n";
$output = array();
exec(dirname($_SERVER['argv'][0]) . "/sql.cli.php $db_tbl search", $output, $return_val);
if ($return_val == 0) {
    $search['search'] = '/%SEARCH%/';
    $replace['search'] = join("\n", $output);
} else {
    die(basename($_SERVER['argv'][0]) . " Error: could not execute sql.cli.php.\n");
}

echo "Generating form validation data...\n";
$output = array();
exec(dirname($_SERVER['argv'][0]) . "/validation.cli.php $db_tbl", $output, $return_val);
if ($return_val == 0) {
    $search['form_validation'] = '/%FORM_VALIDATION%/';
    $replace['form_validation'] = join("\n", $output);
} else {
    die(basename($_SERVER['argv'][0]) . " Error: could not execute validation.cli.php.\n");
}

/******************************************************************************
 * WRITE FILES
 *****************************************************************************/

// (1) Admin script.
if (file_exists("$admin_dir/$admin_script")) {
    echo "Admin script already exists: $admin_dir/$admin_script\n";
} else {
    echo "Writing admin script: $admin_dir/$admin_script\n";
    $fp = fopen("$admin_dir/$admin_script", "w");
    fwrite($fp, preg_replace($search, $replace, $skel_files['admin_script']));
    fclose($fp);
}

// (2) Admin list template.
if (file_exists("$admin_tpl_dir/$admin_list_template")) {
    echo "Admin list template already exists: $admin_tpl_dir/$admin_list_template\n";
} else {
    echo "Writing admin list template: $admin_tpl_dir/$admin_list_template\n";
    $fp = fopen("$admin_tpl_dir/$admin_list_template", "w");
    fwrite($fp, preg_replace($search, $replace, $skel_files['admin_list_template']));
    fclose($fp);
}

// (3) Admin form template.
if (file_exists("$admin_tpl_dir/$admin_form_template")) {
    echo "Admin form template already exists: $admin_tpl_dir/$admin_form_template\n";
} else {
    echo "Writing admin form template: $admin_tpl_dir/$admin_form_template\n";
    $fp = fopen("$admin_tpl_dir/$admin_form_template", "w");
    fwrite($fp, preg_replace($search, $replace, $skel_files['admin_form_template']));
    fclose($fp);
}

// (4) Public script.
if (file_exists("$public_dir/$public_script")) {
    echo "Public script already exists: $public_dir/$public_script\n";
} else {
    echo "Writing public script: $public_dir/$public_script\n";
    $fp = fopen("$public_dir/$public_script", "w");
    fwrite($fp, preg_replace($search, $replace, $skel_files['public_script']));
    fclose($fp);
}

// (5) Public list template.
if (file_exists("$public_tpl_dir/$public_list_template")) {
    echo "Public list template already exists: $public_tpl_dir/$public_list_template\n";
} else {
    echo "Writing public list template: $public_tpl_dir/$public_list_template\n";
    $fp = fopen("$public_tpl_dir/$public_list_template", "w");
    fwrite($fp, preg_replace($search, $replace, $skel_files['public_list_template']));
    fclose($fp);
}

// (6) Public detail template.
if (file_exists("$public_tpl_dir/$public_detail_template")) {
    echo "Public detail template already exists: $public_tpl_dir/$public_detail_template\n";
} else {
    echo "Writing public detail template: $public_tpl_dir/$public_detail_template\n";
    $fp = fopen("$public_tpl_dir/$public_detail_template", "w");
    fwrite($fp, preg_replace($search, $replace, $skel_files['public_detail_template']));
    fclose($fp);
}

echo "Done!\n";


/******************************************************************************
 * FUNCTIONS
 *****************************************************************************/

function trashFile($file_path_name)
{
    global $user_trash_folder;
    static $file_prefix;

    if (!isset($file_prefix)) {
        $file_prefix = time();
    } else {
        $file_prefix++;
    }

    // Make user trash folder.
    if (!is_dir($user_trash_folder)) {
        echo "Attempting to create user trash folder: $user_trash_folder/\n";
        mkdir($user_trash_folder);
        chmod($user_trash_folder, 0777);
    }
    if (!is_dir("$user_trash_folder") || !is_writable("$user_trash_folder")) {
        die("User trash directory not available: $user_trash_folder/\n");
    }

    // Move file to trash.
    if (file_exists($file_path_name)) {
        rename($file_path_name, sprintf('%s/%s_%s', $user_trash_folder, $file_prefix, basename($file_path_name)));
        printf("Moved: %s -> %s\n", $file_path_name, sprintf('%s/%s_%s', $user_trash_folder, $file_prefix, basename($file_path_name)));
    } else {
        printf("File not found: %s\n", $file_path_name);
    }
}

?>