com.planet_ink.coffee_mud.WebMacros
Class INIModify

java.lang.Object
  com.planet_ink.coffee_mud.WebMacros.StdWebMacro
      com.planet_ink.coffee_mud.WebMacros.INIModify

All Implemented Interfaces:

CMObject, WebMacro, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class INIModify
extends StdWebMacro

Constructor Summary

INIModify()

Method Summary

protected void	addChannelsVar(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq, java.lang.String index, java.lang.StringBuilder str)
protected void	addCommandJournalsVar(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq, java.lang.String index, java.lang.StringBuilder str)
protected void	addForumJournalsVar(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq, java.lang.String index, java.lang.StringBuilder str)
protected void	addIChannelsVar(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq, java.lang.String index, java.lang.StringBuilder str)
protected void	addIMC2ChannelsVar(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq, java.lang.String index, java.lang.StringBuilder str)
protected java.lang.String	buildChannelsVar(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq)
protected java.lang.String	buildCommandJournalsVar(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq)
protected java.lang.String	buildForumJournalsVar(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq)
protected java.lang.String	buildIChannelsVar(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq)
protected java.lang.String	buildIMC2ChannelsVar(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq)
protected java.lang.String	getChannelsValue(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq, java.lang.String index)
boolean	isAdminMacro() Whether this macro is restricted to the admin web server.
boolean	modified(java.util.Set<java.lang.String> H, java.lang.String s)
java.lang.String	name() The public name of this macro
java.lang.String	runMacro(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq, java.lang.String parm, com.planet_ink.coffee_web.interfaces.HTTPResponse httpResp) This method is executed only if this macro returns false for preferBinary().
void	updateINIFile(java.util.List<java.lang.String> page)

Methods inherited from class com.planet_ink.coffee_mud.WebMacros.StdWebMacro

clearWebMacros, clearWebMacros, colorwebifyOnly, compareTo, copyOf, getHTTPFileData, grabFile, helpHelp, helpHelp, helpHelp, htmlIncomingFilter, htmlIncomingFilter, htmlOutgoingFilter, htmlOutgoingFilter, ID, initializeClass, isAWebPath, L, newInstance, parseOrderedParms, parseParms, parseParms, preferBinary, runBinaryMacro, safeIncomingfilter, webify

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

INIModify

public INIModify()

Method Detail

name

public java.lang.String name()

Description copied from interface: WebMacro

The public name of this macro

Specified by:

name in interface CMObject

Specified by:

name in interface WebMacro

Overrides:

name in class StdWebMacro

Returns:

The public name of this macro

See Also:

Environmental.Name()

isAdminMacro

public boolean isAdminMacro()

Description copied from interface: WebMacro

Whether this macro is restricted to the admin web server.

Specified by:

isAdminMacro in interface WebMacro

Overrides:

isAdminMacro in class StdWebMacro

Returns:

true if the macro is restricted to the admin web server

updateINIFile

public void updateINIFile(java.util.List<java.lang.String> page)

modified

public boolean modified(java.util.Set<java.lang.String> H,
                        java.lang.String s)

runMacro

public java.lang.String runMacro(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq,
                                 java.lang.String parm,
                                 com.planet_ink.coffee_web.interfaces.HTTPResponse httpResp)

Description copied from interface: WebMacro

This method is executed only if this macro returns false for preferBinary(). It will execute the macro and return its results as a string, which is then substituted for the macro reference in the web page where the macro was found. The response object is used to set cookies and headers only. Any response body is in the return object. Since 99% of macros are only filling in an existing page, nothing will be done with that anyway, and is only important when isAWebPath return true.

Specified by:

runMacro in interface WebMacro

Overrides:

runMacro in class StdWebMacro

Parameters:

httpReq - the external requests object

parm - any parameter strings given to the macro

httpResp - the response, with headers

Returns:

the string result of running this macro

See Also:

WebMacro.preferBinary(), HTTPRequest

getChannelsValue

protected java.lang.String getChannelsValue(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq,
                                            java.lang.String index)

addChannelsVar

protected void addChannelsVar(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq,
                              java.lang.String index,
                              java.lang.StringBuilder str)

buildChannelsVar

protected java.lang.String buildChannelsVar(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq)

addIChannelsVar

protected void addIChannelsVar(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq,
                               java.lang.String index,
                               java.lang.StringBuilder str)

buildIChannelsVar

protected java.lang.String buildIChannelsVar(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq)

addIMC2ChannelsVar

protected void addIMC2ChannelsVar(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq,
                                  java.lang.String index,
                                  java.lang.StringBuilder str)

buildIMC2ChannelsVar

protected java.lang.String buildIMC2ChannelsVar(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq)

addCommandJournalsVar

protected void addCommandJournalsVar(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq,
                                     java.lang.String index,
                                     java.lang.StringBuilder str)

buildCommandJournalsVar

protected java.lang.String buildCommandJournalsVar(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq)

addForumJournalsVar

protected void addForumJournalsVar(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq,
                                   java.lang.String index,
                                   java.lang.StringBuilder str)

buildForumJournalsVar

protected java.lang.String buildForumJournalsVar(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq)