Add token support to the holding page

This is what I thought, but it is a real shame as there is potential here.

I might have to look in the module myself to see if the code could be wrapped with a simple parser that could look for simple tokens such as {domainname}, {day}, {month}, {year} so that it could be adapted in this way.

I'm thinking something along the lines of:

drupal_page_header();
$output = file_get_contents(holding_parser($holding_page), $holding_state);
print $output;

This would require adding a checkbox to the admin page to enable/disable parsing and one additional function parse the &holding_page.

Being really, really new to Drupal (and a php novice) I could have a stab at this, but not really sure at this stage how I would update all the admin side of things etc.

Cheers,

Roy

Ok,

I've had a play with the module I have installed and its working well.

First I added this code to the holding_admin() function:

$form['holding_parse_state'] = array(
    '#type' => 'checkbox',
    '#title' => t('Parse holding page for tokens'),
    '#description' => t("Tick to parse the holding page for the tokens {domainname}, {day}, {month}, {year}, {hour}, {minute}, {second}"),
    '#default_value' => variable_get('holding_parse_state', 0),
  );

The admin page shows the new field correctly and stores the value in the variable table as i:1; or i:0;

Then I changed the following in the holding_boot() function:

if (is_array($holding_sites) && in_array($site, $holding_sites)) {
    $holding_page = variable_get('holding_page', '');
    $holding_parse_state = variable_get('holding_parse_state', 0);

    if (!$holding_page) {
      drupal_set_message(t('No holding page has been set.'), 'warning');
      return;
    }

    drupal_page_header();
    $output = holding_parser(file_get_contents($holding_page), $holding_parse_state);
    print $output;

Finally I added the new holding_parser() function beneath holding_boot():

/**
 * holding_parser().
 */
function holding_parser($page, $parse_state) {
  if ($parse_state) {
    while (substr_count($page, "{domainname}") > 0) {
      $page= str_replace("{domainname}", $_SERVER["HTTP_HOST"], $page);
    }

    while (substr_count($page, "{year}") > 0) {
      $page= str_replace("{year}", date('Y'), $page);
    }
  };
  return $page;
}

As you can see so far I have only added support for {domainname} and {year} and I have not attempted to optimise the routine in any way - simply using a separate while for each token.

I'm interested to know what you think.

Cheers,

Roy

I'll look in to that. However in the mean time I have developed the module as follows.

/**
 * holding_parser().
 */
function holding_parser($page, $parse_state) {
  if ($parse_state) {
    while (substr_count($page, "{server:") > 0) {
    	$token = holding_token($page, "{server:");
    	$value = holding_token_value($token);
    	$page = str_replace($token, $_SERVER[$value], $page);
    }

    while (substr_count($page, "{date:") > 0) {
    	$token = holding_token($page, "{date:");
    	$value = holding_token_value($token);
    	$page = str_replace($token, date($value), $page);
    }

    while (substr_count($page, "{time:") > 0) {
    	$token = holding_token($page, "{time:");
    	$value = holding_token_value($token);
    	$page = str_replace($token, date($value), $page);
    }
  };
  return $page;
}

2 additional function for my own token parser. These I guess will be replaced once I understand the other project.

/**
 * holding_token().
 */
function holding_token($page, $tokenname) {
  $startpos = stripos($page, $tokenname);
  $endpos = stripos($page, "}", $startpos);
  $token = substr($page, $startpos, $endpos - $startpos + 1);
  
  return $token;
}

/**
 * holding_token().
 */
function holding_token_value($token) {
  $startpos = stripos($token, ":");
  $endpos = stripos($token, "}", $startpos);
  $token = substr($token, $startpos + 1, $endpos - $startpos - 1);
  
  return $token;
}

Finally the admin page changes:

$form['holding_parse_state'] = array(
    '#type' => 'checkbox',
    '#title' => t('Parse holding page for tokens'),
    '#description' => t("Tick to parse the holding page for the tokens {server:value}, {date:value} and (time:value}."),
    '#default_value' => variable_get('holding_parse_state', 0),
  );

I will look at the token stuff and work out how to integrate. That may take it bit longer though. But for now this will do for me ;-)

Cheers,

Roy

FYI... I have taken your advice on board and have now started the token integration. I am having a few issues getting token to parse and replace at the moment but have narrowed the changes down to the following.

All other code has been removed.

holding.info
dependencies[] = token

holding.module: holding_boot()

  ...
// Load token module functions
drupal_load('module', 'token');
  ...
  ...
$output = file_get_contents($holding_page);

if (module_exists('token') and $holding_parse_state) {
  $output = token_replace($output, 'global');
}

drupal_page_header();
print $output;

holding.module: holding_admin()

$form['holding_parse_state'] = array(
  '#type' => 'checkbox',
  '#title' => t('Parse holding page for tokens'),
  '#description' => t("Tick to parse the holding page for the tokens. The token module is required for this."),
  '#default_value' => variable_get('holding_parse_state', 0),
  );

holding.install:

/**
 * Implementation of hook_uninstall().
 */
function holding_uninstall() {
  variable_del('holding_sites');
  variable_del('holding_page');
  variable_del('holding_parse_state');
}

The next step will be to see if I can do this via a proper patch.

Cheers,

Roy

Yeah I know... Need to understsnd the patch system next...

So how do you go about "depending" but not "depending" ;-)

Also I'm having issues getting toekn to actually do anything.If I start a patch will you be able to help?

Cheers,

Roy

OK, I've created a patch file. Let me know if I have done this correctly. I used diff to create a patch file for the three files I touched individually and then tar'd them together.

Cheers,

Roy

I've removed the dependency and simply gone with the module_exists() option as you suggested.

The tar file I attached had the individual .patch files inside. I've now attached the two .patch files directly. The .info file has been reverted as I have removed the dependency.

Finally the holding_parser() function no longer exists as I am now using token. All in all a much simpler solution. If only I could get it to work!!!

Cheers,

Roy

OK, I'm hoping you can now help me crack this with the patch info I have sent you...

If I remove the drupal_load('module', 'token') line from the holding_boot() function. I get errors when trying to call the token_replace() or token_replace_multiple() functions.

If I leave the drupal_load('module', 'token') line in place, the errors go away but token_replace() doesn't replace the tokens. If I change the function for token_replace_multiple() then I get error messages from the function - due to invalid parameters, so I know the functions are being called.

Even if I hard code a call like this print token_replace_multiple('[yyyy]', 'node') all I get back is [yyyy].

Any help would be appreciated.

Cheers,

Roy

I see you've made a feature request on the token page (didn't know there was a "site logo" - where is that exactly), I've also updated my issue on there as I think it maybe because we are in offline mode...

Let's see if we can get the token guys involved in this.

Cheers,

Roy

Confirmed by the token guys that replace_token() can't be called in _boot(). What would happen if we moved the display functionality to _init()?

Cheers,

Roy

Update:

renaming holding_boot() to holding_init() still works and I am able to get the 'global' tokens to work. For some reason the 'node' tokens still will not update.

Also, as to your request for the site-logo, we can add two hooks to the holding module which will allow the introduction of new tokens. So, I believe this means we can create a 'holding' object and have our own tokens such as:

[site-domain] - without the 'http://'
[site-image] - As you asked for

and so on...

I'll provide another patch update later once I've worked out the token hooks.

Cheers,

Roy

OK,

I think I've cracked it. Attached you will find patches for the module files.

High level overview:

All files - Version updated to 1.3 and added my username

.install
Added the removal of the new 'holding_parse-state' variable

.module
_boot() is now _init() - There was no effect on the modules behaviour with this change
Added wrap for parsing

_admin()
Added 'holding_parse_state' to the admin page

_token_values()
Added new hook for the Token module. Specifically added a new 'type' called 'server' which adds all the values for the $_SERVER variable

For an example of this holding page with replaced tokens try www.soundchaser.me.uk.

Not sure what happens next...

Cheers,

Roy

OK, I'll look in to delaying... and will sort out the patching stuff

Cheers,

Roy

Ok, I've managed to create a single patch file. The changes now include updates to the readme file and I have reverted the version changes I made plus removed the unecessary comments.

I'm glad you've said you'd work on the _boot()/_init() changes as I failed miserably...

However, I cannot make head nor tail out of how to apply a patch to the module. The documentation seems to skirt around the process but actually how to do it.

I've attached the patch so hopefully you can apply.

Cheers,

Roy

Would appreciate understanding how to apply the patch. But I'm obviously missing something as I cannot see how to do it - and I've read the docs.

I really would like to understand, as I would like to offer the 'server' variables to Token, but don;t want to have to go through all this again.

Just need to understand, learn and do it... Can it really be that difficult?

Cheers,

Roy

OK, here;s what I don't understand. I can apply a patch on my side, but how does that help you/the module? I was kind of expecting it to patch something here...

I thought 'I' was patching 'your' module. Or was I just providing a patch for 'you' to review.

I am guessing now that the patch you have sent me is simply to align it your holding module I have installed locally and that this will bring our code in to line with each other?

Cheers,

Roy

Right... Finally... I think I've got it... (sorry for being so slow with this!!!)

Applied you patch here and can see what you've changed and how you've changed it. I also like the way the parse option doesn't show unless Token is enabled and how you've pulled the tokens through to the admin page as well.

Obviously I've lost my [http_host] token that I need at the moment, but now I'll go and patch Token, now that I know what I'm doing and submit it over there.

So is this now going to make it in to a formal update?

Cheers,

Roy

Good point... I'll certainly think about that and see where best to place my comments/experiences...

Thanks for your help, look forward to the official update coming out in the near future.

Cheers,

Roy