NukeWrap 2.0

Table of Contents

What is It?

NukeWrap is a PHP-Nuke module that enables virtually any web content such as HTML, scripts (home pages, galleries, shopping carts, PHP, Perl, ASP, etc.) to be easily incorporated into your PHP-Nuke site. Just call the NukeWrap module with any URL and it will display it in your PHP-Nuke main area/window (security settings permitting). I call it a content wrapper (takes any existing content anywhere and wraps your PHP-Nuke site around it. NukeWrap uses an <iframe> which must be supported by the browser and JavaScript if you want to resize the <iframe> in some older browsers.

Installation

• Unzip to your PHP-Nuke root directory to create the modules/NukeWrap/ subdirectory and copy other neded files
• 'modules/NukeWrap/nukewrap.cfg' must be writable by the webserver in order to save changes (hint: chmod a+w nukewrap.cfg)

How Do I Use It?

Just call NukeWrap in module fashion with the page variable set to the URL or location that you want to display in PHP-Nuke. If 'Require that displayed URL be in URL List?' = Yes, then you may use either the URL or the Alias that you defined. For example, an anchor would look like:

URL: <a href="modules.php?name=NukeWrap&page=index.php">My Site</a>

Alias: <a href="modules.php?name=NukeWrap&page=mysite">My Site</a>

Cool! For a remote site you would use:

URL: <a href="modules.php?name=NukeWrap&page=http://www.phpnuke.org/">PHP-Nuke Site</a>

Alias: <a href="modules.php?name=NukeWrap&page=phpnuke">PHP-Nuke Site</a>

And you'll show the PHP-Nuke home page in your main window.

URL Options

• The height (vertical size) of the iframe in pixels can be set using &height=
• The width (horizontal size) of the iframe in pixels or percent can be set using &width=
• Auto resize of the page can be set with &resize=1 (this will override the height value if set)
• The page title can be set using &title=

Example:

modules.php?name=NukeWrap&page=http://www.PHP-Nuke.org/&height=1000&width=90%

modules.php?name=NukeWrap&page=http://www.PHP-Nuke.org/&resize=1

modules.php?name=NukeWrap&page=http://www.PHP-Nuke.org/&title=The future of the Web

In the past tou could use the PHP-Nuke index variable to show the center and right blocks by including &index=1.  Not sure if this still works.

Example:

modules.php?name=NukeWrap&page=http://www.PHP-Nuke.org/&index=1

NukeWrap Block

NukeWrap includes a block that will automatically display a list of links for all URLs that you have added in the URL List section of NukeWrap administration.

Where To Use It?

You can place references in your user home page, linked to the main menu or to sub menus, on user pages and just about anywhere. You can use hrefs <img srcs, Javascript dynamic page generation, html redirection, and even php scripts by sending Location: headers.

The real magic is that other applications written in php or perl or Javascript or whatever run as if they were a part of PHP-Nuke, seamlessly and with little effort. If you do this, be sure to give proper credit though. As long as it is pleasant looking running standalone, it will look great running in PHP-Nuke via NukeWrap.

Configuration

The following options can be set in the administraion interface:

Default

The Default settings section defines overall settings for the NukeWrap module.

• 'Require that displayed URL be in URL List?' - When enabled, any URL passed as the page variable to be displayed must be present in the URL List, otherwise, any page can be displayed if it is not restricted by the other settings.
• 'Strict check against URL List?' - When enabled, a URL passed as the page variable must exactly match a URL in the URL List, example: http://www.spidean.com/modules.php?name=Downloads to be displayed must have an exact match in the URL List. If not enabled, then it is a "fuzzy" match, example:  http://www.spidean.com/modules.php?name=Downloads to be displayed may match just http://www.spidean.com in the URL List.  So you can allow certain domains or servers, etc. to display pages.
• 'Require pages to be local to this server?' - Controls whether pages not on your local domain or server can be displayed.
• 'Auto-resize window?' - Uses JavaScript to resize the content window length to use the entire length of your PHP-Nuke content area.
  *************************************************************
  Auto-resize does not size the window to the content that is being displayed.  This is not doable because of security settings in most modern browsers.
  *************************************************************
• 'Height of viewing window in pixels or percent' - The length of the window that will contain the page. This value will only be used if Auto-resize window = No. Newer browsers support percentages, oler ones may not.
• 'Width of viewing window in pixels or percent' - The width of the window that will contain the page.
• 'Top and bottom margins in pixels' - The margin space around the top and bottom of the content.
• 'Left and right margins in pixels' - The margin space around the left and right of the content.
• 'Border' - Whether to show a border around the content area.
• 'Scrollbars' - Whether to show scrollbars always, never or when needed to scroll content.

URL List

If 'Require that displayed URL be in URL List?' = Yes in the Deafult settings, then any URL to be displayed must be entered here in order to be displayed.

• 'URL' - The URL that you are adding.
• 'Alias' - A short name for this URL that can be used as the page variable in the URL that you use to call the page.

The rest of the setting in URL List are the same as the Default settings, but override the Default setting for the specific URL that you add.

Known Issues

• When using special characters (i.e.  & % @ :) in the page variable in the address bar, you must translate the characters into their ASCII hex value preceded by a %. For example: ? is %3F and & is %26.

Example:

http://www.spidean.com/modules.php?name=NukeWrap&page=http://www.example.com/page.php?somevar=50&othervar=login

Becomes:

http://www.spidean.com/modules.php?name=NukeWrap&page=http://www.example.com/page.php%3Fsomevar=50%26othervar=login

Bugs and Feedback

Please send bug reports or feedback by visiting http://spidean.mckenzies.net.

PostWrap is Free Software released under the GNU/GPL license.