Simple question on creating a module

Sergeant Joined: Dec 26, 2005 Posts: 81

Hello all, long time nuke user but first time module writer. I'm porting over one of my web based ftp clients i wrote a while back and im in now playing with the module structure and such. One question i have...and ill use the module Your_Account as an example...is that when i look at the code, i see that it uses $op (registered global) in a switch statement to determine what function to go to and what parameters to pass that function.

My real question is, is that when you first go into Your_Account by clicking on the link under modules...theres no op variable in the query string to tell it where to go...and since there is no op at all the switch statement is not evaluated at all so no default case is ran.

Need to know the methodology behind this so i write my module correctly to fit inside the framework. Thanks for the answers!

Sergeant Joined: Dec 26, 2005 Posts: 81

Here is what i have for code so far...any advice is appreciated!

Code:

<?php
if (!eregi("modules.php", $PHP_SELF)) {
die ("You can't access this file directly...");
}
$index = 1;
require_once("mainfile.php");
$module_name = basename(dirname(__FILE__));
get_lang($module_name);
include("header.php");

function view ($username, $prev_directory, $curr_directory) {
OpenTable();
echo " IN VIEW ";
if (! $curr_directory) {
$curr_directory = "\/";
}

list($ftp_conn, $ftp_username, $ftp_pass, $ftp_host) = ftp_connect_login($username);
if ($curr_directory) {
$curr_list = ftp_rawlist($ftp_conn, $curr_directory);
}
else {
$curr_list = ftp_rawlist($ftp_conn);
}

if((is_array($curr_list)) && (count($curr_list) > 0 )) {
$curr_list = listing_parser($curr_list);

for ($ii = 0; $ii < count($curr_list); $ii++) {
if ((trim($listing[$i]['name']) == '..') || (trim($listing[$i]['name']) == '.')) {
next($curr_list);
}
$curr_item = trim($listing[$i]['name']);
$obj_type = substr($listing[$i]['perms'], 0, 1);
$next_listing = $curr_directory."\/".$curr_item;
if ($object_type == 'd') {
echo "<tr><td align='center'>";
echo " <a href='modules.php?name=Remote_FTP&op=view&curr_directory=$next_listing&prev_directory=$curr_directory>$curr_item - Folder</td></tr>";
}
else {
echo "<tr><td align='center'>";
echo " <a href='ftp://$ftp_username:$ftp_pass@$ftp_host$next_listing'>$curr_item</a>";// - File -- <a href='ftp_directory.php?main_path=$main_path&delete=$curr_folder'>Delete?</a></td></tr>";
}
}
}

CloseTable();

}
function display_ftp_table() {
}
function ftp_connect_login ($username) {
global $db, $user_prefix;
$results = $db->sql_query("SELECT user_id FROM ".$user_prefix." WHERE username = '$username'");
echo " Results 1: $resutls ";
$row = $db->sql_fetchrow($results);

$results = $db->sql_query("SELECT * FROM nuke_ftp_connect_info WHERE user_id = '$row[user_id]'");
$row = $db->sql_fetchrow($results);
echo " Results2: ";
while (list($key, $val) = each($row)) {
echo "$key : $val ";
}

$usr_ftp_host = ftp_connect($row[ftp_host]);
$login = ftp_login($usr_ftp_host, $row[ftp_username], $row[ftp_password]);

set_time_limit(160);

return array($usr_ftp_host, $row[ftp_username], $row[ftp_password], $row[ftp_host]);
}

function listing_parser($listing) {
$structure = array();
for ( $i = 0; $i < count($listing); $i++ ) {
$current = $listing[$i];

$structure[$i]['perms'] = substr($current, 0, 10);
$structure[$i]['number'] = trim(substr($current, 11, 3));
$structure[$i]['owner'] = trim(substr($current, 15, 8));
$structure[$i]['group'] = trim(substr($current, 24, 8));
$structure[$i]['size'] = trim(substr($current, 33, 10));
$structure[$i]['month'] = trim(substr($current, 44, 3));
$structure[$i]['day'] = trim(substr($current, 48, 2));
$structure[$i]['time'] = substr($current, 51, 5);
$structure[$i]['name'] = substr($current, 56, strlen($current) - 55);#$structure[$i]['name'] = substr($current, 56, strlen($current) - 55);
echo ' name: '.$structure[$i]['name'];
echo ' perms: '.$structure[$i]['perms'];
echo ' number: '.$structure[$i]['number'];
echo ' owner: '.$structure[$i]['owner'];
echo ' group: '.$structure[$i]['group'];
echo ' size: '.$structure[$i]['size'];
echo ' month: '.$structure[$i]['month'];
echo ' day: '.$structure[$i]['day'];
echo ' time: '.$structure[$i]['time'];
}
return $structure;
}

include("footer.php");
switch ($op) {
case "view":
echo " IN VIEW ";
view($username, $prev_directory, $curr_directory);
break;
default:
echo " IN DEFAULT ";
view($username, $prev_directory, $curr_directory);
break;
}
?>

Sergeant Joined: Dec 26, 2005 Posts: 81

hmm, do i have this in the wrong section? I see 37 views but no responses...i posted this yesterday though it says today (in my time zone)...just curious thinking maybe it needed to be in another section. Thanks.

Site Admin Joined: Aug 17, 2003 Posts: 12397

Do you have a specific question?

Sergeant Joined: Dec 26, 2005 Posts: 81

ethana wrote:

Hello all, long time nuke user but first time module writer. I'm porting over one of my web based ftp clients i wrote a while back and im in now playing with the module structure and such. One question i have...and ill use the module Your_Account as an example...is that when i look at the code, i see that it uses $op (registered global) in a switch statement to determine what function to go to and what parameters to pass that function.

My real question is, is that when you first go into Your_Account by clicking on the link under modules...theres no op variable in the query string to tell it where to go...and since there is no op at all the switch statement is not evaluated at all so no default case is ran.

Need to know the methodology behind this so i write my module correctly to fit inside the framework. Thanks for the answers!

My apologies, i was not clear. On the $op variable that i was talking about that determines what function to execute (Your_Account was my example) is not set or even used when you initially go into the Your_Account module when you click on it from under the modules navigation. How is this working then? How does the module know what to execute? Is there a methodology behind this? How do i take my module and make it run a default function even if there is not $op and no switch is evaluated like in Your_Account? I'm assuming theres a standard way of doing this b/c quite a few modules do it. Thanks all and i hope this was clearer!

Site Admin Joined: Aug 17, 2003 Posts: 12397

Ah I see the problem now. Your code is not correct.

You don't want to call include("footer.php") before your switch statement. That will kill your script before it ever executes the switch

You are better to place the header.php and footer includes in the body of your functions.

i.e.

Code:

<?php
if (!eregi("modules.php", $PHP_SELF)) {
...

function view( ...
include("header.php");
...
include("footer.php");
}

switch ($op) {
...

I hope that makes sense

Sergeant Joined: Dec 26, 2005 Posts: 81

ok, thats understandable...but still though, what is the standard way for when you first enter a module through the Modules navigation when the link is only modules.php?name=Your_Account and no $op is set in the query string? The switch statement wont evaluate to even run the default b/c of this, or am i wrong? Thanks for your response Smile

Site Admin Joined: Aug 17, 2003 Posts: 12397

The switch will always go to the default: case then

Sergeant Joined: Dec 26, 2005 Posts: 81

Cool, thanks for the answers...im a Perl guy...much more strict than PHP..well if you include the strict pragma!

Thanks again!