19 replies to this topic

[Cris D.]

File Name: save_content_externally
File Submitter: Cris D.
File Submitted: 28 Mar 2008
File Updated: 2 Aug 2008
File Category: Miscellaneous

Snippet: save_content_external
Version: 1.0
Author: Cris D
Date: 2008/03/28
For: Etomite V 0.6.1.4
Uses: Basically, it creates new etomite pages without having to use the manager.
It collects variables and saves them to a new site document under a parent you specify.
Document variables are collected from (in order of priority)
1) $_POST variables with the $prefix pre-pended
2) snippet call parameters sent in the snippet call
3) snippet default parameters set in the snippet

NOTE: To use this snippet for 0.6.1.4 and earlier, you will need to update your manager/processors/cache_sync.class.processor.php file.
See Etomite forum thread: http://www.etomite.com/index.php?s=...ost&p=46982 for more detail. If you do not, you will get a "no file exists" error.
For Etomite V1.0 and later, this modification has already been made.

This snippet collects $_POST['params']first then if blank, uses snippet call and in-snippet parameters as defaults.

Installation Instructions:

Copy and paste this text file to your snippet library.

Either call this snippet by placing it on a page and pointing the form action="nn" to it or use $etomite->runSnippet() to call it.

Testing can be done easily by manually placing the $_POST['vars']; in the top of the snippet until you work out what you want to actually send to it!

2008/06/08 Upon review, I discovered that the delete action actually removes the document from the table: it does not mark it as deleted-to be purged later when the recycle bin is emptied. This action can not be undone. For a safer way of deleting a document, the deleted='1', deletedon='[timestamp]' and deletedby='['internalKey']' could be used. The deleted, deletedon and deletedby fields have not been included to be collected in this snippet, but could be added to the CODEswitch ($action){case 'delete': part quite easily.

CHANGELOG: 2008/08/02
Fixed typo with $_SESSION['internakKey']
Changed default user to 1 (admin) instead of '0'- NULL

Warning: This snippet plays with the etomite_site_content table. It creates documents on the fly and if you accidentally pass parameters to the table that arte incorrect, you can completely stop your site (and manager) from functioning! The default parameters being passed are OK so if in doubt, don't send it! If you know what you are doing and still want to send parameters and stuff it up, all can be restored by simply using phpMyAdmin to delete the documents you have created. This snippet is sailing close to the wind with manager modifications: if use of the snippet causes major problems with your installation because you are passing invalid parameters- you are on your own. Be warned!

Click here to download this file

[Ralph]

You can use $etomite->syncsite(); right in your snippet to update the Etomite cache...

[Cris D.]

It is in the snippet, but if the file is not updated, it causes the errors mentioned.

[Ralph]

Right... The fix will be in Prelude v1.0...

[mikef]

Thanks for this Cris - easy to use and does what I need for repeatedly creating small groups of pages. Now I just need to sort out how to create the groups needed as well!

[Cris D.]

I use the snippet to create a parent (for an individual person) and then create sub-pages for each submitted book. I identify the corrent parent the page the sub-page belongs to by cross referencing the $_SESSION['internalKey'] with the parent created_by with a database query, and send the 'parent'=$etomite->getDocument() in the sub page array. This may not suit your needs, but might assist in tackling the problem.

If you know the values of your parents, you could easily create an array of parents you want to create:

$groups=array(group1, group2,group3);
foreach($groups as $g){
$params=array('parent'=>$g);
$ids[]=$etomite->runSnippet('save_content_external',$params);
}
print_r($ids);

Glad you can use it...

Edited by Cris D., 01 August 2008 - 10:31 PM.

[mikef]

Thanks Cris, but not waht I'm trying to do. I'll look at it over the weekend if I can sort out another unrelated problem thats worrying me.

The biggest problem I had getting the page trees created turned out to be (I think) a bug in runSnippet (reported to the tracker).

[mikef]

There's a small typo in the download file: the line

$defaultUser= isset($_SESSION['internakKey']) ? $_SESSION['internalKey'] : '0';

should be

$defaultUser= isset($_SESSION['internalKey']) ? $_SESSION['internalKey'] : '0';

[Cris D.]

Thanks Mike, snippet updated!

[mikef]

This code does what I wanted to do with document groups for the new pages.

It may help others work out how to solve other similar problems

// create a group and add pages into it
// params group (name - text) pages (id,id)
// returns group id or message 

	$sql = "INSERT INTO ".$etomite->db."documentgroup_names(name) VALUES ('$name');";
	$rs = mysql_query($sql);
	if(!$rs){
	  return "An error occured while attempting to create the new group ($name).";
	}
	if(!$key=mysql_insert_id()) {
	  return "Couldn't get the id for group $name!";
	}
	foreach (explode(',' , $pages) as $id) {
		$sql = "INSERT INTO ".$etomite->db."document_groups(document_group, document) VALUES ('$key','$id');";
		$rs = mysql_query($sql);
		if(!$rs){
			  $err .= "An error occured while attempting to add the document to the group (key=$key id=$id).";
		}
	}
if ($err) return $err;
return $key;

[Jelmer]

Thnx Mike, this was exactly what I need, I think. I'll get back to you!

[Ralph]

I'd suggest using as many API function calls as possible as opposed to using direct MySQL database calls... Doing so allows Etomite to use its internal error handling and can usually reduce the overall amount of code required... But that's just me...

[Cris D.]

I agree Ralph, however, the above code uses the mysql_insert_id() and without numerous iterations of putIntTableRow()
$temp=getIntTableRow(with some convoluted where query to ensure you are collecting the right row)
$key=$temp[0]['id'];
$fields=array($key, $id);
putIntTableRow($fields,'table');

Unless there are API's that return the key of inserted rows, sometimes they are more trouble than they are worth. I too have resorted to direct database queries in cases like the above. Is there an etomite-friendly way of doing what Mike has done using existing API's? If there is, it escapes me.

[mikef]

I'll use the APIs if I think they'll save me time, or result in clearer code. That wasn't the case here.

[Ralph]

@Cris

$etomite->insertId() and $etomite->affectedRows() come in handy and will work with both internal and external database API functions... Probably another one of those areas that would benefit from a tutorial if I can ever muster up the time...

[mikef]

Ralph, on Aug 4 2008, 02:54 AM, said:

I'd suggest using as many API function calls as possible as opposed to using direct MySQL database calls... Doing so allows Etomite to use its internal error handling and can usually reduce the overall amount of code required... But that's just me...

having now seen what Etomite's "internal error handling" does on database errors, I'm glad I'm not using it!

[Cris D.]

No offence Ralph, but I think that's a fair call Mike... They're not the prettiest of pages!
What about outputting system error messages with a user-defined chunk in cocoon so that admin can style an etomite error message to look like part of the site?- just a thought (and actually waaaaay of topic - sorry).

[mikef]

I'd prefer cocoon to give the snippet writer the option of handling database errors. The use of a duplicate key is in many cases a recoverable error (by the snippet, not the core), rather than just cause for crashing the page, especially as transactions aren't supported.

Edited by mikef, 05 August 2008 - 09:48 AM.

[Ralph]

Hey, I'll be the first to chime right in on the error handling issue... All I can say is "I didn't write it." and haven't bothered making changes because I would like an entire rewrite of that module... For a production site, however, the errors should never present themselves to end users if adequate checks and balances are in place... Also remember that some of the error message is purposely ambiguous for security reasons and that additional information can be seen if debugging is turned on...

[mikef]

Ralph, on Aug 5 2008, 01:48 PM, said:

Hey, I'll be the first to chime right in on the error handling issue... All I can say is "I didn't write it."

Which is why I started with

Quote

I'd prefer cocoon to ...

New post started at http://www.etomite.c...?showtopic=7990