New Admin-Tool: Droplets

[Ruud]

Droplets

We are proud to announce a new WebsiteBaker tool that will allow designers to use PHP code within the output of any module or template running in WebsiteBaker 2.7.

We have been thinking a long time for the right name, and we have finally named them Droplets.

To use Droplets you simply add a string in your editor/module/template enclosed in double square brackets (i.e. [[myfunction]]). This string will be replaced by the result value of the code that is linked in the Droplet manager.

Droplets are defined in the Admin-Tools, using the Droplets page.
This page will give an overview of all currently installed Droplets, with the possibility to add/change/delete them.

The Droplet tool is installed the same way as you would install any other module or admin-tool.
To be able to filter all  output the installation will also alter the output_filter module so that it will call the Droplets tool. Note that the standard output filter functionality is not altered, even after un-installing the Droplets at a later time.

The installation also includes a series of fully functional example Droplets so you can see results directly after installing.

Example code:

Droplet Name: Hello
Droplet Code: return 'Hello <b>websitebaker</b> Visitor.';

In your WYSIWYG section you can now simple add [[Hello]].
When the page is called it will show "Hello websitebaker Visitor."

A detailed Help page can be found on the AMASP project.

• English: http://www.websitebakers.com/pages/droplets/help/help-en.php
• German: http://www.websitebakers.com/pages/droplets/help/help-de.php

The latest version of the Droplets tool can be downloaded from the AMASP project website:
http://www.websitebakers.com/pages/admin/admin-tools/droplets.php

When you have created a Droplet yourself and want to share this with the community you can use this form to get your Droplet listed in the Official Droplet Library.


Ruud & pcwacht
(With many thanks to erpe and Aldus for testing and creating the Help pages)

[Stefek]

Respect!

This is really great stuff and a great X-Mas / New Years Present.

Have seen a lot of good stuff last time - this one was the missing droplet. 

Best Regards,
Stefek

[pcwacht]

The Droplet makes good use of the editarea module -> http://www.websitebaker2.org/forum/index.php/topic,12280.0.html


Have fun,
John

[Hans]

Thanks Ruud and Pcwacht for this wonderfull addition. Works great, great present at the end of 2008.
have a good 2009!
Hans

[mr-fan]

ok ruud, that toy is great!

i'am no coder but i won't implement a few snippets that i can modify by the backend...so my question?

this code example:

Code:

ob_start();
return page_content(2); //change for variable content
$topl=ob_get_contents();
ob_end_clean();

if ($topl=="") {
$section_id = 70; // ID change for fix content
$query_sec = $database->query("SELECT section_id,module FROM ".TABLE_PREFIX."sections WHERE section_id = '$section_id' ");
if($query_sec->numRows() > 0) {
$section = $query_sec->fetchRow();
$section_id = $section['section_id'];
$module = $section['module'];
require(WB_PATH.'/modules/'.$module.'/view.php');
}
} else {
retun '<div align="center">';
return '$topl';
return '</div>';
}

how i can make it run with your system? i 've only changed the echo in return but show's droplet debug mode like this

Code:

Parse error: syntax error, unexpected T_CONSTANT_ENCAPSED_STRING in C:\XAMPP\htdocs\modules\droplets\droplets.php(46) : eval()'d code on line 16

what is important to implement such small snippets....

or for a banner-droplet like ralf worked out with this function

Code:

// Datei mit den Texten (mit Pfadangabe!)
$txt_file = 'textfile.txt';
// Zaehlerdatei (mit Pfadangabe, Datei wird automatisch angelegt)
$txt_file_stepper = 'textfile.stp';


/**
 * Liest die Texte aus der Datei $txt_file die jeweils mit --NEXT-- von einander
 * getrennt sind in ein Array ein.
 * Gibt bei einem Fehler ein leeres Array zurueck
 *
 * @return ARRAY
 */
function get_text_array() {
  global $txt_file;
  $result_array = array();
  if (file_exists($txt_file)) {
    // Zufallstexte in ein Array einlesen
    $result_array = preg_split("/--NEXT--/", join('', file($txt_file))); }
  return $result_array; 
} // get_text_array()

/**
 * Liest aus dem ARRAY $this_array einen zufaelligen
 * Eintrag aus und gibt ihn zurueck.
 *
 * @param ARRAY $this_array
 * @return STR
 */
function read_array_random($this_array) {
  if (sizeof($this_array) < 1) {
    return 'ERROR'; }
  if (floor(phpversion()) < 5) {
    // Zufallsgenerator initialisieren
    srand((double)microtime()*1000000); }
  return $this_array[rand(0, sizeof($this_array) -1)];
} // read_array_random()

/**
 * Gibt aus dem Array $this_array den Eintrag $step aus.
 * $step wird aus einer Zaehlerdatei ausgelesen, anschliessend
 * um 1 erhoeht und in die Zaehlerdatei zurueckgeschrieben.
 * Wird $step groesser als $this_array wird $step wieder auf 0
 * gesetzt und faengt von vorne an zu zaehlen.
 * Existiert die Zaehlerdatei nicht, wird sie angelegt.
 *
 * @param ARRAY $this_array
 * @return STR
 */
function read_array_continous($this_array) {
  global $txt_file_stepper;
  if (!file_exists($txt_file_stepper)) {
    // Zaehlerdatei anlegen
    $stepper = fopen($txt_file_stepper, "w+");
    fwrite($stepper, "0");
    fclose($stepper); }
  // Zaehlerdatei auslesen
  $stepper = fopen($txt_file_stepper, "r+");
  fseek($stepper, 0, SEEK_SET);
  $step = intval(fread($stepper, 10));
  if ($step > sizeof($this_array)-1) {
    // $step ist groesser als das Array und wird deshalb auf 0 gesetzt
    $step = 0; }
  // Ergebnis: Eintrag $step aus dem Array
  $result = $this_array[$step];
  // $step fuer den naechsten Aufruf um 1 erhoehen oder auf Anfang setzen
  ($step < sizeof($this_array)-1) ? $step++ : $step = 0;
  // Zaehlerdatei aktualisieren
  fseek($stepper, 0, SEEK_SET);
  fwrite($stepper, $step, 10);
  fclose($stepper);
  // Ergebnis zurueckgeben
  return $result;
} // read_array_continous()

and this call

Code:

$array = get_text_array();
if (!empty($array)) {
  echo "continuos: ". read_array_continous($array) ."<br>";
  echo "random:    ". read_array_random($array); }
else {
  echo "error while reading textfile"; }

a little hint for a non-coder to manage snippets with your handy tool.....

regard martin

[Ruud]

Hi Martin,

I am glad you are asking these questions. It will become the basis of the future documentation.
It is hard to think of all possible things people would like to use it for and provide examples and explanations for that.
This thread should become a first resource for that.

Now to your problem:

Just copy some snippet code and put it in as a Droplet will not work.
Snippets and Droplets are different things.

What is important to remember is that the Droplet call (ie [[droplet]]) is going to be replaced by the returned value of the PHP code.
The PHP code can "return" only once. Return really means "go back" to the calling code, so the rest of the code will not be executed anymore.

Your first example would not work, just because there are multiple return values. (the error was just about a typo (retun instead of return))

Secondly what you should know is that the page is already built by WB before the droplets will do anything.
The require(some-module/view.php) call will not work because that relies on building the output by WB (and that was already done before).

A possible solution to do what you want is to get the database content of your "section 70" directly and return that, but it will be unformatted output, and it will only work on WYSIWYG content.
I changed your code a bit, and this works on my testbox. It might be just good enough for you too.

Code: (solution)

global $database;
ob_start();
echo page_content(2); //when ob_start is used, we can just echo, it will be buffered
$topl=ob_get_contents();
ob_end_clean();

if ($topl=="") {
  $section_id = 1; // ID change for fix content
  $query_sec = $database->query("SELECT content FROM ".TABLE_PREFIX."mod_wysiwyg WHERE section_id = '$section_id' ");
  if($query_sec->numRows() > 0) {
    $wysiwyg = $query_sec->fetchRow();
    $topl = $wysiwyg['content'];
  }
}

return '<div align="center">'.$topl.'</div>';

The second example might just work without much problems.
This first block should be put completely in the droplet code.

Just change the first few lines to:

Code: (untested)

// Datei mit den Texten (mit Pfadangabe!)
$txt_file = 'textfile.txt';
// Zaehlerdatei (mit Pfadangabe, Datei wird automatisch angelegt)
$txt_file_stepper = 'textfile.stp';

//Added for droplet use

$array = get_text_array();
return read_array_continous($array);

// the rest of the original code..

I hope this helps a bit.

Ruud

[mr-fan]

thx for your answer,

this is important info's for me....

Just copy some snippet code and put it in as a Droplet will not work.
Snippets and Droplets are different things.

Your first example would not work, just because there are multiple return values.

Secondly what you should know is that the page is already built by WB before the droplets will do anything.
The require(some-module/view.php) call will not work because that relies on building the output by WB (and that was already done before).

your changed code works only with wysiwyg! right... so this snippet goes his way as always (hardcoded in template )

but the second i try out in the evening!

now i understand the output/input of your droplet maschine better...

i've had idea's of easy template-building (like a construction kit of droplets), yet..... but this is a different operating mode i know now!

regard and thanks for this great modul!
martin

[Argos]

I tried the Droplets module, but it doesn't work. Installation went fine, but when I call a droplet it just show the tag. But none of the default droplets work. And it doesn't matter if I put the tag in WYSIWYG content, or directly in the template.

Do I miss something? If I'm right, I only have to install the module, and put the tags in the content, right?

[Ruud]

The installation needs to patch the normal (WB2.7) output filter.
The only reason I can think of is that the patch was not done.

It should have given you a message if patching that file was successful or not.
Did you see that message?

Ruud

[Argos]

I deinstalled and reinstalled again, and yes, there is an error about failed patching. I guess I missed that somehow the first time. It said that you can manually do the patch, but I cannot find documentation about how to do that...

[Ruud]

I deinstalled and reinstalled again, and yes, there is an error about failed patching. I guess I missed that somehow the first time. It said that you can manually do the patch, but I cannot find documentation about how to do that...

In the droplets tool page there is a help/readme button.
That one shows a window with information about the tool.
The sections "Installation Problems" explains what to do.

Another option is to make the directory /modules/oputput_filter (and the files in it) writable for WB (apache user), and uninstall/install again.

Ruud

[Argos]

I deinstalled and reinstalled again, and yes, there is an error about failed patching. I guess I missed that somehow the first time. It said that you can manually do the patch, but I cannot find documentation about how to do that...

In the droplets tool page there is a help/readme button.
That one shows a window with information about the tool.
The sections "Installation Problems" explains what to do.

Another option is to make the directory /modules/oputput_filter (and the files in it) writable for WB (apache user), and uninstall/install again.

The Help button opened my frontend homepage, instead of help info. But I found the info in the zip file, and patched the file. That didn't work, so I tried your second suggestion and set the files and dir to 777. Now the patching succeed, but the module doesn't work. It shows a completely empty page, with in the source code only the bare droplet code.

[Ruud]

Now the patching succeed, but the module doesn't work. It shows a completely empty page, with in the source code only the marked out script code (do a view source at http://www.maycroft.com/cms/pages/search.php)

Probably your server does not allow the 777 for viewing? I have seen that before.
Now the patching is done, you might need to change it back to the original setting (644/755).

[doc]

Hello,

first of all great and easy to use tool 

The help file will only open correct, if WB is installed within the document root of your webspace, not in a subdirectory as the URL starts with /modules/xxxx/helpfile. Should be replaced by WB_URL . '/modules/xxx/helpfile'.

Great job guys.

Regards Christian

[Argos]

Now the patching succeed, but the module doesn't work. It shows a completely empty page, with in the source code only the marked out script code (do a view source at http://www.maycroft.com/cms/pages/search.php)

Probably your server does not allow the 777 for viewing? I have seen that before.
Now the patching is done, you might need to change it back to the original setting (644/755).

Nope, didn't work. Well, I put the old file back.

[Ruud]

@argos
Thats a shame.. I am very curious about your php configuration.
Could you create a phpinfo() page somewhere on that server and PM me the link for it?
I don't know if that will bring a quick solution, but it might tell us something.

@doc
I had noticed that already, it will be fixed in the next version.
The next version will also make use of the new frontendfilter tool.

@All Droplet users.
Just noticed I left some debugging information activated. 
It will show the droplet code when viewing the source of your webpage.
You can disable that info by just removing line 58 in the file droplets.php

Code:

echo "<!-- Droplet Debug (".$functionName.")\n".$content."\n-->\n\n";

It is not a big risk to show the code, the droplet code is publicly available anyway. It just shouldn't show.

Within a few days I will make version 0.2 available. This version will not show this information anymore.

Ruud

[Argos]

Just noticed I left some debugging information activated. 
It will show the droplet code when viewing the source of your webpage.
You can disable that info by just removing line 58 in the file droplets.php

Code:

echo "<!-- Droplet Debug (".$functionName.")\n".$content."\n-->\n\n";

It is not a big risk to show the code, the droplet code is publicly available anyway. It just shouldn't show.

No, it's not a risk, but it did mess up the layout on my site. So it really shoulde be removed to prevent trouble.

[Argos]

Ruud, for the next version maybe it's an idea to show the droplet tags in the overview? There is room for another column, and then you can quickly select the tag when you need it.

[Ruud]

@All
Argos' problem was caused by a third party PHP product called "suhosin" that his hosting company installed.
This completely disabled the PHP eval() functionality. Also our standard code sections would not work anymore.
After allowing the eval() function the Droplets worked.

@Argos
An idea is to create a mouse-over popup that will display the comment field.
This is the place where a "Use: [[mydroplet]]" is written, including optional information.
Since droplet commandlines can be complicated (see randomimage) with multiple optiopnal parameters it will not simply fit into a table field.
It is the second time this is asked, so I will think about it

Ruud

[Ruud]

Hi All,

I added some new Droplets to the Official Droplet Library

Greeting: Displays a greeting depending on the time of day. (Good morning/afternoon/evening)

MoreLikeThis: A simple pagetagging system using the keyword field of a page. Displays a "More pages like this" list.

Childpages: An example of using the show_menu2 snippet within a Droplet. Shows the childpages of the current page.

Youtube: A simple way of adding a Youtube movie to any page or module.


Ruud

[dbs]

test with greeting & morelikethis = don't work 
but loginbox & searchbox works.

[Ruud]

test with greeting & morelikethis = don't work 

Can you give us a bit more details?
The code like "greeting" is very simple and should always work.

Questions:
1. Did you copy all the code into a new Droplet?
2. Did you gave it the same name as you are using in the example?
3. What is the ouput that you can see?
4. Are there any errors?
5. Can we have a look on a website somewhere?

Ruud

[dbs]

gottomio, thx for your questions. now it works.
the name was not the same. sorry.
very nice tool

[Ruud]

A new version is available. (Version 0.2.1)

Donwload is available through the AMASP website: http://www.websitebakers.com/pages/admin/admin-tools/droplets.php

This version will make use of the new Frontendfilter when that module is installed. If it is not installed the original patch in the WB2.7 output filter is used.

This version will also use the new editarea editor. The editarea editor is not a module but installed as an "include" in the WB2.7 backend.

Finally this version will allow you to create a downloadable backup (zip file) of your list of Droplets.
Restoring has top be done manually at this time. An automated restore will be available in a future version.

Thanks to Stefek for styling the backend..

Upgrading older versions will keep any self-made Droplets available. Please note that uninstalling the Droplets tool will remove all Droplets (including self-made) from your server!

Ruud

[doc]

Hi Ruud,

just tested the latest version, works like a charme.

Regards Christian