/* /verbs/common/help.c
* from the Dead Souls Object Library
* created by Descartes of Borg 951021
* Version: @(#) help.c 1.15@(#)
* Last Modified: 96/12/14
*/
#include <lib.h>
#include <dirs.h>
#include <daemons.h>
inherit LIB_DAEMON;
static private string Error, SeeAlso = "";
static private mapping Indices;
static private void LoadIndices();
string GetHelp(string str);
string GetHelpByIndex(string index, string topic);
string GetTopic(string index, string topic);
varargs string array GetIndices(string topic);
static void create() {
daemon::create();
SetNoClean(1);
Error = 0;
LoadIndices();
}
int CanAccess(object who, string index) {
switch(index) {
case "admin commands":
return archp(who);
case "creator commands": case "creator documents":
case "library objects": case "daemon objects":
return creatorp(who);
case "builder commands":
return builderp(who);
default:
return 1;
}
}
static private void LoadIndices() {
string array tmp;
function f;
string dir;
f = function(string str) { return str[0..<3]; };
Indices = ([]);
tmp = get_dir(DIR_ADMIN_VERBS + "/*.c") + get_dir(DIR_ADMIN_CMDS + "/*.c")
+ get_dir(DIR_SECURE_ADMIN_CMDS + "/*.c");
Indices["admin commands"] = map(tmp, f);
tmp = get_dir(DIR_COMMON_VERBS+"/*.c") +
get_dir(DIR_COMMON_CMDS + "/*.c") +
get_dir(DIR_SECURE_COMMON_CMDS + "/*.c") +
get_dir(DIR_ITEM_VERBS + "/*.c") +
get_dir(DIR_PLAYER_VERBS+"/*.c") +
get_dir(DIR_PLAYER_CMDS+"/*.c") +
get_dir(DIR_ROOM_VERBS + "/*.c") +
get_dir(DIR_SPELL_VERBS + "/*.c") +
//get_dir(DIR_SECURE_BUILDER_CMDS + "/*.c") +
//get_dir(DIR_BUILDER_CMDS + "/*.c") +
get_dir(DIR_SECURE_PLAYER_CMDS + "/*.c");
Indices["commands"] = map(tmp, f);
tmp = get_dir(DIR_CREATOR_VERBS+"/*.c") + get_dir(DIR_CREATOR_CMDS+"/*.c")
+ get_dir(DIR_SECURE_CREATOR_CMDS + "/*.c");
Indices["creator commands"] = map(tmp, f);
tmp = get_dir(DIR_SECURE_BUILDER_CMDS + "/*.c") +
get_dir(DIR_BUILDER_VERBS + "/*.c") +
(get_dir(DIR_BUILDER_CMDS + "/*.c") || ({}));
Indices["builder commands"] = map(tmp, f);
tmp = get_dir(DIR_UNDEAD_VERBS "/*.c");
Indices["undead commands"] = map(tmp, f);
tmp = SOUL_D->GetEmotes();
Indices["feelings"] = tmp;
tmp = filter(map(get_dir(DIR_SPELLS "/*.c"),
function(string file) {
file = DIR_SPELLS "/" + file;
if( file->GetVerb() == "cast" ) {
return file->GetSpell();
}
return 0;
}), (: $1 :));
Indices["spells"] = tmp;
tmp = filter(map(get_dir(DIR_SPELLS "/*.c"),
function(string file) {
file = DIR_SPELLS "/" + file;
if( file->GetVerb() == "pray" ) {
return file->GetSpell();
}
return 0;
}), (: $1 :));
Indices["prayers"] = tmp;
if( tmp = get_dir(DIR_PLAYER_HELP + "/") )
Indices["player documents"] = tmp + ({ "soul" });
else Indices["player documents"] = ({ "soul" });
if( tmp = get_dir(DIR_CREATOR_HELP "/") )
Indices["creator documents"] = tmp;
else Indices["creator document"] = ({});
if( tmp = (string array)CLASSES_D->GetClasses() )
Indices["classes"] = tmp;
else Indices["classes"] = ({});
if( tmp = (string array)RACES_D->GetRaces(1) )
Indices["races"] = tmp;
else Indices["races"] = ({});
if( tmp = get_dir(DIR_LAW_HELP "/") )
Indices["law"] = tmp;
else Indices["law"] = ({});
if( tmp = get_dir(DIR_RELIGION_HELP "/") )
Indices["religion"] = tmp;
else Indices["religion"] = ({});
Indices["library objects"] = ({});
foreach(dir in ({ DIR_LIB, DIR_SECURE_LIB })){
if( !(tmp = get_dir(dir + "/*.c")) ) continue;
else Indices["library objects"] +=
map(tmp, (: $(dir)+"/"+$1[0..<3] :));
}
Indices["daemon objects"] = ({});
foreach(dir in ({ DIR_DAEMONS, DIR_SECURE_DAEMONS })) {
if( !(tmp = get_dir(dir + "/*.c")) ) continue;
else Indices["daemon objects"] +=
map(tmp, (: $(dir)+"/"+$1[0..<3] :));
}
}
string GetHelp(string str) {
string *tmp, choice,ret ="";
string topic;
int x;
Error = 0;
if( !str || str == "" || str == "help" ) {
return ("Syntax: <help>\n"
" <help index>\n"
" <help TOPIC>\n"
" <help INDEX TOPIC>\n\n"
"The special topic, \"help index\", puts you into "
"a menu driven index of categories for which help exists.\n\n"
"For players, \"help commands\" will provide an index of "
"available player commands.\n "
"For creators, \"help creator commands\" provides an "
"index of available creator commands.\n\n "
"Try \"help commands\" "
"and \"help creator commands\" first. \n\n"
" ");
}
if(member_array(str, CHAT_D->GetChannels()) != -1 &&
str != "newbie" && member_array(str, CLASSES_D->GetClasses()) == -1){
return "See: help channels";
}
if( sscanf(str, "adverbs %s", topic) || str == "adverbs" ) {
return (string)SOUL_D->GetHelp(str);
}
tmp = GetIndices(str);
if( sizeof(tmp) > 0){
if( sizeof(tmp) > 1){
if(member_array("admin commands",tmp) != -1) choice = "admin commands";
else if(member_array("creator commands",tmp) != -1) choice = "creator commands";
else if(member_array("player commands",tmp) != -1) choice = "player commands";
else if(member_array("builder commands",tmp) != -1) choice = "builder commands";
}
if(!choice) choice = tmp[0];
tmp -= ({ choice });
if(sizeof(tmp)) SeeAlso = "\nThere also exists help for \"" + str + "\" under the following "
"indices:\n" + implode(tmp, ", ");
ret = GetHelpByIndex(choice, str);
if(ret) ret += SeeAlso;
SeeAlso = "";
return ret;
}
topic = "";
str = trim(str);
while( (x = strsrch(str, " ")) != -1 ) {
if( topic != "" ) {
topic = topic + " " + str[0..(x-1)];
}
else {
topic = str[0..(x-1)];
}
str = str[(x+1)..];
if( Indices[topic] && strlen(str) ) {
return GetHelpByIndex(topic, str);
}
}
if(this_player() && adminp(this_player())){
Error = "Help for the topic \"" + str + "\" could not be found.";
}
else {
Error = "The search for help on the topic \"" + str + "\" yields you no results.";
}
return 0;
}
string GetHelpByIndex(string index, string topic) {
mixed array tmparr, fun;
mapping tmpmap;
object ob;
string help, file, tmpstr;
if( this_player() && !CanAccess(this_player(), index) ) {
Error = "You do not have access to that information.";
return 0;
}
switch(index) {
case "admin commands": case "creator commands": case "undead commands":
case "commands": case "builder commands" :
switch(index) {
case "admin commands":
if( file_exists( DIR_ADMIN_VERBS + "/" + topic + ".c") )
file = DIR_ADMIN_VERBS + "/" + topic;
else if( file_exists( DIR_ADMIN_CMDS + "/" + topic + ".c") )
file = DIR_ADMIN_CMDS + "/" + topic;
else file = DIR_SECURE_ADMIN_CMDS + "/" + topic;
break;
case "creator commands":
if( file_exists( DIR_CREATOR_VERBS + "/" + topic + ".c") )
file = DIR_CREATOR_VERBS + "/" + topic;
else if( file_exists(DIR_CREATOR_CMDS + "/" + topic + ".c") )
file = DIR_CREATOR_CMDS + "/" + topic;
else file = DIR_SECURE_CREATOR_CMDS + "/" + topic;
break;
case "builder commands":
if( file_exists( DIR_BUILDER_VERBS + "/" + topic + ".c") )
file = DIR_BUILDER_VERBS + "/" + topic;
else if( file_exists(DIR_BUILDER_CMDS + "/" + topic + ".c") )
file = DIR_BUILDER_CMDS + "/" + topic;
else file = DIR_SECURE_BUILDER_CMDS + "/" + topic;
break;
case "commands":
foreach(string directory in ({ DIR_COMMON_VERBS,
DIR_COMMON_CMDS,
DIR_SECURE_COMMON_CMDS,
DIR_ITEM_VERBS,
DIR_PLAYER_VERBS,
DIR_PLAYER_CMDS,
DIR_SECURE_PLAYER_CMDS,
DIR_ROOM_VERBS,
DIR_SPELL_VERBS })) {
if( file_exists(directory + "/" + topic + ".c") ) {
file = directory + "/" + topic;
break;
}
}
break;
case "undead commands":
file = DIR_UNDEAD_VERBS + "/" + topic;
break;
}
if( !file_exists(file + ".c") ) {
Error = "No such " + index[0..<2] + " exists.";
return 0;
}
if( catch(help = file->GetHelp(topic)) ) {
Error = "An error occurred in attempting to access help.";
return 0;
}
if( !help ) {
string *syn, *pd;
string line;
pd = regexp(explode(parse_dump(), "\n"), file[1..]);
syn = ({});
foreach(line in pd) {
sscanf(line, "%*s"+file[1..]+") %s", tmpstr);
syn += ({ tmpstr });
}
if( !sizeof(syn) ) {
if( function_exists("help", load_object(file)) ) {
Error = " ";
file->help();
write(SeeAlso);
SeeAlso = "";
return 0;
}
Error = "Unable to locate any syntax information on " +
topic + ".";
return 0;
}
help = "Syntax: " + topic + " " + syn[0] + "\n";
if( sizeof(syn) == 1 ) help += "\n";
else {
foreach(line in syn[1..])
help += " " + topic + " " + line + "\n";
help += "\n";
}
help += "No detailed documentation exists for this command.";
}
help = "Index: %^GREEN%^" + index + "%^RESET%^\n" +
"Topic: %^GREEN%^" + topic + "%^RESET%^\n\n" + help;
return help;
case "player documents": case "creator documents":
case "law":
switch(index) {
case "player documents":
if( topic == "soul" ) {
help = SOUL_D->GetHelp("soul");
help = "Index: %^GREEN%^" + index + "%^RESET%^\n" +
"Topic: %^GREEN%^" + topic + "%^RESET%^\n\n" + help;
return help;
}
file = DIR_PLAYER_HELP "/" + topic;
break;
case "creator documents":
file = DIR_CREATOR_HELP "/" + topic;
break;
case "law":
file = DIR_LAW_HELP "/" + topic;
break;
}
if( !file_exists(file) ) {
Error = "No such " + index[0..<2] + " is available.";
return 0;
}
if( !(help = read_file(file)) ) {
Error = "The document " + topic + " was empty.";
return 0;
}
help = "Index: %^GREEN%^" + index + "%^RESET%^\n" +
"Topic: %^GREEN%^" + topic + "%^RESET%^\n\n" + help;
return help;
case "feelings":
help = SOUL_D->GetHelp(topic);
if( !help ) {
Error = "No such " + index[0..<2] + " is available.";
return 0;
}
help = "Index: %^GREEN%^" + index + "%^RESET%^\n" +
"Topic: %^GREEN%^" + topic + "%^RESET%^\n\n" + help;
return help;;
case "library objects":
topic = GetTopic(index, topic);
if( !file_exists(topic+".c") ){
Error = "No such topic found.";
return 0;
}
if( catch(help = topic->GetHelp(topic)) ) {
Error = "An error occurred in attempting to access help.";
return 0;
}
if( !help ) {
help = "No synopsis available for this object.\n\n";
}
else {
help = "Synopsis:\n" + help + "\n\n";
}
tmparr = stat(topic + ".c");
tmpstr = "Object: " + topic + "\n"
"Last Modified: " + ctime(tmparr[1]) + "\n";
if( tmparr[2] ) {
tmpstr += "Last Loaded: " + ctime(tmparr[2]) + "\n\n";
}
tmparr = inherit_list(ob = find_object(topic));
if( !sizeof(tmparr) ) {
tmpstr += "No inherited objects\n\n";
}
else {
tmpstr += "Inherits:\n" + format_page(tmparr, 4) + "\n";
}
tmparr = functions(ob, 1);
tmpmap = ([]);
foreach(fun in tmparr) {
if( function_exists(fun[0], ob) != topic ) {
continue;
}
if( fun[0] == "#global_init#" ) {
continue;
}
if( tmpmap[fun[0]] ) {
continue;
}
else {
tmpmap[fun[0]] = ([ "type" : fun[2],
"args" : (fun[1] ? fun[3..] : ({})) ]);
}
}
help = tmpstr + help;
if( !sizeof(tmparr) ) {
help += "No functions\n\n";
}
else {
string fnc;
help += "Functions:\n";
tmparr = sort_array(keys(tmpmap), 1);
foreach(fnc in tmparr) {
help += tmpmap[fnc]["type"] + fnc + "(" +
implode(tmpmap[fnc]["args"], ", ") + ")\n";
}
}
help = "Index: %^GREEN%^" + index + "%^RESET%^\n" +
"Topic: %^GREEN%^" + topic + "%^RESET%^\n\n" + help;
return help;
case "daemon objects":
topic = GetTopic(index, topic);
if( !topic || catch(help = topic->GetHelp(topic)) ) {
Error = "An error occurred in attempting to access help for that.";
return 0;
}
if( !help ) {
help = "No synopsis available for this object.\n\n";
}
else {
help = "Synopsis:\n" + help + "\n\n";
}
tmparr = stat(topic + ".c");
tmpstr = "Object: " + topic + "\n"
"Last Modified: " + ctime(tmparr[1]) + "\n";
if( tmparr[2] ) tmpstr += "Last Loaded: " + ctime(tmparr[2]) + "\n\n";
tmparr = inherit_list(ob = find_object(topic));
if( !sizeof(tmparr) ) tmpstr += "No inherited objects\n\n";
else tmpstr += "Inherits:\n" + format_page(tmparr, 4) + "\n";
tmparr = functions(ob, 1);
tmpmap = ([]);
foreach(fun in tmparr) {
if( function_exists(fun[0], ob) != topic ) continue;
if( fun[0] == "#global_init#" ) continue;
if( tmpmap[fun[0]] ) continue;
else tmpmap[fun[0]] = ([ "type" : fun[2],
"args" : (fun[1] ? fun[3..] : ({})) ]);
}
help = tmpstr + help;
if( !sizeof(tmparr) ) help += "No functions\n\n";
else {
string fnc;
help += "Functions:\n";
tmparr = sort_array(keys(tmpmap), 1);
foreach(fnc in tmparr)
help += tmpmap[fnc]["type"] + fnc + "(" +
implode(tmpmap[fnc]["args"], ", ") + ")\n";
}
help = "Index: %^GREEN%^" + index + "%^RESET%^\n" +
"Topic: %^GREEN%^" + topic + "%^RESET%^\n\n" + help;
return help;
case "religons": case "religion":
if( file_exists(DIR_RELIGION_HELP "/" + topic) ) {
help = read_file(DIR_RELIGION_HELP "/" + topic);
help = "Index: %^GREEN%^" + index + "%^RESET%^\n" +
"Topic: %^GREEN%^" + topic + "%^RESET%^\n\n" + help;
return help;
}
Error = "No such religion exists.";
return 0;
case "races":
if( help = (string)RACES_D->GetHelp(topic) ) {
help = "Index: %^GREEN%^" + index + "%^RESET%^\n" +
"Topic: %^GREEN%^" + topic + "%^RESET%^\n\n" + help;
return help;
}
else if( file_exists(DIR_RACE_HELP + "/" + topic) ){
help = read_file(DIR_RACE_HELP + "/" + topic);
return help;
}
Error = "There is no such race.";
return 0;
case "spells": case "prayers":
ob = SPELLS_D->GetSpell(topic);
if( !ob ) {
Error = "No such spell exists.";
return 0;
}
if( !(help = ob->GetHelp(topic)) ) {
Error = "No help is available for that spell.";
return 0;
}
help = "Index: %^GREEN%^" + index + "%^RESET%^\n" +
"Topic: %^GREEN%^" + topic + "%^RESET%^\n\n" + help;
return help;
case "classes":
if( help = (string)CLASSES_D->GetHelp(topic) ) {
help = "Index: %^GREEN%^" + index + "%^RESET%^\n" +
"Topic: %^GREEN%^" + topic + "%^RESET%^\n\n" + help;
if( file_exists(DIR_CLASS_HELP + "/" + topic) )
help += read_file(DIR_CLASS_HELP + "/" + topic);
return help;
}
Error = "No such class exists.";
return 0;
default:
Error = "No help exists for the index " + index + ".";
return 0;
}
}
varargs string array GetIndices(string topic) {
string array topics, val;
string ind, tmp;
if( !topic ) {
return sort_array(keys(Indices), 1);
}
topics = ({});
foreach(ind, val in Indices) {
if( !CanAccess(this_player(), ind) ) {
continue;
}
tmp = GetTopic(ind, topic);
if( member_array(tmp, val) != -1 ) {
topics += ({ ind });
}
}
return sort_array(topics, 1);
}
string GetTopic(string index, string topic) {
string array dirlist;
string dir;
if( index != "library objects" && index != "daemon objects" ) {
return topic;
}
if( index == "library objects" ) {
dirlist = ({ DIR_LIB, DIR_SECURE_LIB });
}
else {
dirlist = ({ DIR_DAEMONS, DIR_SECURE_DAEMONS });
}
if( strlen(topic) > 2 && topic[<2..] == ".c" ) {
topic = topic[0..<3];
}
if( file_exists(topic + ".c") ) {
return topic;
}
foreach(dir in dirlist) {
if( file_exists(dir + "/" + topic + ".c") ) {
return dir + "/" + topic;
}
}
return 0;
}
string array GetTopics(string index) {
string array topics = Indices[index];
if( !topics ) {
return 0;
}
else {
return sort_array(topics, 1);
}
}
string GetLastError() {
return Error;
}
void Reload() {
LoadIndices();
}
