AutoTheme for PostNuke

Version: 1.0

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. I call it a content wrapper (takes any existing content anywhere and wraps your PHP-Nuke site around it. Uses an <iframe> which must be supported by the browser and JavaScript to resize the <iframe>.

Installation

Unzip to your modules/ directory to create the NukeWrap/ subdirectory

Configuration

The following options can be set in the nukewrap.cfg:

General

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

'url-security' - Compare URL against URL Security Settings, activates URL checking from the URL Security page. Otherwise, any page can be displayed if it is not restricted by the other settings.
'address-bar-entry' - Allow input from browser address bar, determines whether the user can enter the url in the browser address bar.
'local-pages-only' - Display off-site pages, controls whether pages not on your local domain or server can be displayed.
'use-buffering' - Use buffering of output before sending, buffers the page output.
'use-compression' - Use compressed output, uses compressed output from the server.
'registered-users-only' - Only for registered users, determines whether a user must be registered and logged in to see the NukeWrap page.
'open-direct-msg' - Add link for Open in new window, adds a link to open a new window above and below the page. If one of these links is clicked, the content is opened in a new browser window.
'use-fixed-title' - Use fixed title, displays a fixed title above and below the page.
'auto-resize' - Auto resize window, uses JavaScript to resize the content window.
*************************************************************
*** auto-resize only works with a small hack to the PHP-Nuke footer.php ***
*** in the foot() function around line 71, comment out die(); ***
*** //die(); ***
*************************************************************
'height' - Length of viewing window in pixels, is the length of the window that will contain the page. This value will only be used if Auto resize window = false.
'width' - Width of viewing window in pixels or percent, is the width of the window that will contain the page. Default is 100%

URL Security

If url-security = true in General settings, then any URL must be entered here in order to be displayed.

$authorized_url['http://www.phpnuke.org'] - The URL that you are adding.
'alias' - A short name for this URL that can be used in the URL that you use to call the NukeWrap page.

The following are the same as the General section but override the General setting for the specific URL.

'registered-users-only'
'open-direct-msg'
'use-fixed-title'
'auto-resize'
'height'
'width'

Miscellaneous

The following messages can be easily customized. Just modify the text in your lang-yourlanguage.php file in the modules/NukeWrap/language/ directory.

_NOPAGEMSG No page was defined to display.
_TITLEMSG The following content is from another site.
_TITLEMSGEND The END of content from another site.
_NOTSERMSG Sorry, you are not authorized to use this feature. Please login.
_NOTAUTHHOSTMSG Sorry, this URL is not authorized to be displayed here.
_NOUSERENTRYMSG Sorry, you are not allowed to do that.
_NOTLOCALMSG Sorry, only local pages may be displayed.
_OPENDIRECTMSG Open in new window
_SORRYBROWSER Sorry, your browser does not understand iframes. Here is the
_LINKYOU link
_SORRYBROWSER1 to the page.

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 Compare URL against URL Security = true, 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.PHP-Nuke.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

There are several variables that can be included in the URL that will override the settings in nukewrap.cfg:

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

Using the PHP-Nuke index variable you can show the center and right blocks if you want by including &index=1.

Example:

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

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.

Known Issues

auto-resize only works with a small hack to the PHP-Nuke footer.php in the foot() function around line 71, comment out die(); to read //die();
If you receive odd characters or garbled output, try setting use-compression and/or use-buffering to false.
When using special characters (i.e. & % @ :) in the page variable in the address bar and sometimes in the URL Security settings, you must translate the characters to their ASCII hex value preceded by a %. The ? is %3F and & is %26.

Example:

page=http://somedomain.com/page.php?somevar=50&othervar=login

Becomes:

page=http://somedomain.com/page.php%3Fsomevar=50%26othervar=login

Bugs and Feedback

Please send bug reports or feedback to AbraCadaver@mckenzies.net or visit http://spidean.mckenzies.net.

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