Quick and dirty uptime monitor

Although we use FusionReactor to determine the health of our servers on our team, the environment as a whole is still monitored by another group. And they cannot access FusionReactor. Our previous method of monitoring just a URL worked fine when the servers were not clustered. Now, however, you can't really be sure what instance you're on. Therefore, we get false up/down messages for a specific instance.

What I've done is this, I've got a new monitor.cfm file such as the one below:

<cfscript>
   System = createObject("java","java.lang.System");
JRun = createObject("java","jrunx.kernel.JRun");
</cfscript>
<cfset this_servername = JRun.getServerName()>
<cfoutput>
   Instance: #this_servername#<br>
   Server Name: #cgi.Server_Name#<br>
</cfoutput>
<!--- Change timeout behavior if more than one instance is displayed --->
<cfif isdefined('url.all')>
   <cfset timeoutBehavior=15>
<cfelse>
   <cfset timeoutBehavior=28>
</cfif>
<!--- Ensure that url.instance is defined --->
<cfparam name="url.instance" default="all">


<cfif url.instance EQ 'someinstance' or url.instance EQ 'all'>
<br><br>
<cfset sStatus="">
<cftry>
<cfhttp method="get"
      url="http://someinstance.com:9301/monitor.cfm"
      timeout="#timeoutBehavior#"
      throwOnError="true">

      <cfcatch type="any"><cfset sStatus="bad"></cfcatch>
</cftry>
<b>SOMEINSTANCE 1 - status</b> <cfif sStatus EQ "bad">Down<cfelse>Up</cfif>
<cfif sStatus EQ "" OR sStatus EQ "good">
   <cfoutput>#cfhttp.filecontent#</cfoutput>
</cfif>
</cfif>

This code calls out to a file sitting within the instances built-in web server path. Since I need to leave this enabled to effectively manage the instance anyway, it's a good way to test that it's "alive". That monitor.cfm file contains:

<cfscript>
   System = createObject("java","java.lang.System");
JRun = createObject("java","jrunx.kernel.JRun");
</cfscript>

<cfinclude template="Duration.cfm">
<cfset uptime = duration(server.coldfusion.expiration,now())><br>
<b>Uptime</b><br>
<cfoutput>#uptime.days# Day(s) #uptime.hours# Hour(s) #uptime.minutes# Minute(s)</cfoutput><br>

<cfset this_servername = JRun.getServerName()>
<cfoutput>Instance: #this_servername#</cfoutput>

This display the instance information, and uses the UDF duration call (from CFLIB) to get the uptime count for the server. This information is then used within the first monitor call to display uptime status.

Why bother? Well, I need some type of text on the page to tell the monitor (soon to be Nagios) that my instances are up. And near as I can tell, this is the only accurate way to do so. It's not pretty, I admit, but it gets the job done.

FarCry 4 formtools issues

Here's a strange one that I came across yesterday. I was working on making a new site available for some community type work (www.fouroakskidskampus.com), when I found an issue with the default FarCrycms plugin. I'll post the code, see if you can spot the error.

<!--- wiz: General Details --->
<cfproperty ftseq="1" ftfieldset="Event Overview" ftwizardStep="General Details" name="title" type="string" hint="Title of object." required="no" default="" ftLabel="Title" ftvalidation="required" />
<cfproperty ftseq="2" ftfieldset="Event Overview" ftwizardStep="General Details" name="startDate" type="date" hint="The start date of the event" required="no" default=""ftDefaultType="Evaluate" ftDefault="now()" ftType="datetime" ftDateFormatMask="dd mmm yyyy" ftTimeFormatMask="hh:mm tt" ftToggleOffDateTime="false" ftlabel="Start Date" />
<cfproperty ftseq="3" ftfieldset="Event Overview" ftwizardStep="General Details" name="endDate" type="date" hint="The end date of the event" required="no" default=""ftDefaultType="Evaluate" ftDefault="DateAdd('d', 5, now())" ftType="datetime" ftDateFormatMask="dd mmm yyyy" ftTimeFormatMask="hh:mm tt" ftToggleOffDateTime="false" ftlabel="End Date" />
<cfproperty ftseq="5" ftfieldset="Event Overview" ftwizardStep="General Details" name="displayMethod" type="string" hint="Display method to render." required="yes" default="display" fttype="webskin" ftprefix="displayPage" ftlabel="Content Template" />

The above was pulled from plugins/farcrycms/packages/types/dmEvent.cfc. It was not displaying any webskins, even though they were in the correct path. Placing new webskins in the project folder failed as well. It's only when the webskins existed in the core folders that you actually were able to see them.

<cfproperty ftseq="1" ftfieldset="General Details" ftwizardStep="General Details" name="title" type="string" hint="News title." required="no" default="" ftlabel="Title" ftvalidation="required" />
<cfproperty ftseq="2" ftfieldset="General Details" ftwizardStep="General Details" name="source" type="string" hint="source of the information contained in the content" required="no" default="" ftlabel="Source" />
<cfproperty ftseq="3" ftfieldset="General Details" ftwizardStep="General Details" name="displayMethod" type="string" hint="Display method to render." required="yes" default="display" fttype="webskin" ftprefix="displayPage" ftlabel="Content Template" />
<cfproperty ftseq="4" ftfieldset="Categorisation" ftwizardStep="General Details" name="catNews" type="string" hint="News categorisation." required="no" default="" fttype="category" ftalias="dmnews" ftlabel="News Category" />

This next was pulled from plugins/farcrycms/packages/types/dmNews.cfc. Did you see it? It's not real blatant. Alright, this is where it's at, if you notice that ftseq in dmNews does not skip a sequence. The sequence in dmEvent DOES have a gap. Odd, but that's what seemed to break it. Renaming "ftseq=5" to "ftseq=4" fixed the issue. Groovy, baby.

FarCry plugin breakdown - Part III

Let's finish this up with Part 3. We only have two things to look at yet, and that's our Rule and webskin.

The Rule

<cfcomponent displayname="Mass Mailer Rule" extends="farcry.core.packages.rules.rules" hint="Allows you to select a list for user to sign up for">
   <cfproperty ftSeq="1" ftFieldSet="List" name="intro" type="longchar" hint="Introduction HTML for list." ftLabel="Intro" ftType="longchar" />
   <cfproperty ftSeq="2" ftFieldSet="List" name="ListID" type="UUID" hint="ID of the List to be displayed" ftLabel="List" ftType="UUID" ftJoin="massMailerList" />
   <cfproperty ftseq="3" ftFieldset="List" name="displayMethod" type="string" hint="Display method to render." required="yes" default="display" fttype="webskin" ftprefix="displayList" ftTypename="massMailerList" ftlabel="Content Template" />
   
<cffunction name="execute" hint="Displays the text rule on the page." output="true" returntype="void" access="public">
   <cfargument name="objectID" required="Yes" type="uuid" default="">
   
   <cfset var stObj = getData(arguments.objectid) />
   <cfset var oList = createObject("component","farcry.plugins.massMailer.packages.types.massMailerList") />
   <cfset var stData = oList.getData(stObj.ListID) />
   <cfset var stInvoke = structNew() />   
   <cfscript>
      if (len(stobj.intro))
         arrayAppend(request.aInvocations,stobj.intro);
      stInvoke.objectID = stData.ObjectID;
      stInvoke.typename = application.types.massMailerList.typepath;
      stInvoke.method = stObj.displayMethod;
      arrayAppend(request.aInvocations,stInvoke);
   </cfscript>
</cffunction>
</cfcomponent>

Not too complicated, and once again, formtools comes to our rescue! To get a real breadth of what can be done with rules, you really should take a look at the existing core and farcrycms rules. Some of them have much more functionality than what was required for this rule.

Basically, if you want to have something displayed on the screen, you need to make a cfproperty for it. The usual formtools ideas apply. The items I required were the ID of the list, and the name of the webskin to display it. Formtools can grab this list of webskins for you with the fttype="webskin".

The real magic is in the execute fucntion. It will create our stObj (which the webskin will use), and also invoke the webskin to be used. To be frank, I've not dug into the internals much within rules. This one will get the job done, but I don't have the greatest of knowledge of this piece of FarCry.

The webskin

The essence of the skin is to display two form fields, name and address, and submit this information as a aObjectID into the massMailerList. The nifty drag-n-drop display does this for us, so I simply "borrowed" those pieces to pull this of.

<cfsetting enablecfoutputonly="true">
<!--- @@displayname: Display Mass Mailer Signup Form --->
<!--- @@author: Matthew Williams --->
<cfif isdefined('form.FARCRYFORMSUBMITBUTTON')>

<cfimport taglib="/farcry/core/tags/formtools/" prefix="ft" >
<cfinclude template="/farcry/core/admin/includes/utilityFunctions.cfm">

<cfparam name="form.primaryObjectID" default="">
<cfparam name="form.primaryTypeName" default="">
<cfparam name="form.primaryFieldName" default="">
<cfparam name="form.primaryFormFieldName" default="">
<cfparam name="form.ftJoin" default="">
<cfparam name="form.wizardID" default="">
<cfparam name="form.LibraryType" default="array">
<cfparam name="form.ftLibraryAddNewWebskin" default="libraryAdd"><!--- Method to Add New Object --->
<cfparam name="form.ftLibraryPickWebskin" default="libraryPick"><!--- Method to Pick Existing Objects --->
<cfparam name="form.ftLibraryPickListClass" default="thumbNailsWrap">
<cfparam name="form.ftLibraryPickListStyle" default="">
<cfparam name="form.ftLibrarySelectedWebskin" default="librarySelected"><!--- Method to Pick Existing Objects --->
<cfparam name="form.ftLibrarySelectedListClass" default="thumbNailsWrap">
<cfparam name="form.ftLibrarySelectedListStyle" default="">
<cfparam name="form.ftAllowLibraryAddNew" default=""><!--- Method to Add New Object --->
<cfparam name="form.ftAllowLibraryEdit" default=""><!--- Method to Edit Object --->
<cfparam name="form.PackageType" default="types"><!--- Could be types or rules.. --->
<cfparam name="form.currentpage" default="1">


   
<cfif form.PackageType EQ "rules">
   <cfset PrimaryPackage = application.rules[form.primaryTypeName] />
   <cfset PrimaryPackagePath = application.rules[form.primaryTypeName].rulepath />
<cfelse>
   <cfset PrimaryPackage = application.types[form.primaryTypeName] />
   <cfset PrimaryPackagePath = application.types[form.primaryTypeName].typepath />
</cfif>

<!--- TODO: dynamically determine the typename to join. --->
<cfset request.ftJoin = listFirst(form.ftJoin) />
<cfif NOT listContainsNoCase(PrimaryPackage.stProps[form.primaryFieldname].metadata.ftJoin,request.ftJoin)>
   <cfset request.ftJoin = listFirst(PrimaryPackage.stProps[form.primaryFieldname].metadata.ftJoin) />
</cfif>


<ft:processForm action="Attach,Attach & Add Another">   
   <ft:processFormObjects typename="#request.ftJoin#" /><!--- Returns variables.lSavedObjectIDs --->
   <cfset oPrimary = createObject("component",PrimaryPackagePath)>
   <cfset oData = createObject("component",application.types[request.ftJoin].typepath)>
   <cfloop list="#lSavedObjectIDs#" index="DataObjectID">
      <cfif len(form.wizardID)>               
         <cfset owizard = createObject("component",application.types['dmWizard'].typepath)>
         <cfset stwizard = owizard.Read(wizardID=form.wizardID)>
         
         <cfif form.LibraryType EQ "UUID">
            <cfset stwizard.Data[form.PrimaryObjectID][form.PrimaryFieldname] = DataObjectID>
         <cfelse><!--- Array --->
            <cfset arrayAppend(stwizard.Data[form.PrimaryObjectID][form.PrimaryFieldname],DataObjectID)>   
            <cfset variables.tableMetadata = createobject('component','farcry.core.packages.fourq.TableMetadata').init() />
            <cfset tableMetadata.parseMetadata(md=getMetadata(oPrimary)) />      
            <cfset stFields = variables.tableMetadata.getTableDefinition() />
            <cfset o = createObject("component","farcry.core.packages.fourq.gateway.dbGateway").init(dsn=application.dsn,dbowner="")>
            <cfset aProps = o.createArrayTableData(tableName=form.PrimaryTypename & "_" & form.PrimaryFieldName,objectid=form.PrimaryObjectID,tabledef=stFields[PrimaryFieldName].Fields,aprops=stwizard.Data[PrimaryObjectID][form.PrimaryFieldname])>
            <cfset stwizard.Data[form.PrimaryObjectID][form.PrimaryFieldname] = aProps>
         </cfif>
         
         <cfset stwizard = owizard.Write(ObjectID=form.wizardID,Data=stwizard.Data)>
         <cfset st = stwizard.Data[form.PrimaryObjectID]>
      <cfelse>
         <cfset stPrimary = oPrimary.getData(objectid=form.PrimaryObjectID)>
         
         <cfif form.LibraryType EQ "UUID">
            <cfset stPrimary[form.PrimaryFieldname] = DataObjectID>      
         <cfelse><!--- Array --->
            <cfset arrayAppend(stPrimary[form.PrimaryFieldname],DataObjectID)>                  
         </cfif>      
         
         <cfparam name="session.dmSec.authentication.userlogin" default="anonymous" />
         <cfset oPrimary.setData(objectID=stPrimary.ObjectID,stProperties="#stPrimary#",user="#session.dmSec.authentication.userlogin#")>
         
      </cfif>
   </cfloop>
   
</ft:processForm>
</cfif>

<cfscript>
   formObj.primaryHash = stObj.objectid;
   formObj.primaryNoHash = replace(formObj.primaryHash,'-','','all');
   formObj.userObjHash = createuuid();
   formObj.userObjNoHash = replace(formObj.userObjHash,'-','','all');
</cfscript>

<cfoutput>
<cfif isdefined('form.FARCRYFORMSUBMITBUTTON')>
   <p>Your email address has been added to the list!</p>
</cfif>
<form action="" method="post" id="farcryForm936443538" name="farcryForm936443538" target="" enctype="multipart/form-data" onsubmit="" class="formtool" style="">
   <p>Name: <input type="Text" name="#formObj.userObjHash#Title" id="#formObj.userObjHash#Title" value="" class="" style="" /></p>
   <p>Email:<input type="Text" name="#formObj.userObjHash#Email" id="#formObj.userObjHash#Email" value="" class="" style="" /></p>
   <input type="hidden" name="#formObj.userObjHash#DateAddedinclude" id="#formObj.userObjHash#DateAddedinclude" value="1">
<input type="hidden" name="#formObj.userObjHash#DateAdded" id="#formObj.userObjHash#DateAdded" value="#now()#" style="" /></p>
   <input type="hidden" name="#formObj.userObjHash#ObjectID" value="#formObj.userObjHash#">
   <input type="hidden" name="#formObj.userObjHash#Typename" value="massMailerUser">
   <input type="submit" name="FarcryFormSubmitButton" value="Attach" onclick=";$('FarcryFormSubmitButtonClickedfarcryForm936443538').value = 'Attach';;return realeasyvalidation.validate();" class="formButton " style="" />
   <input type="hidden" name="FarcryFormPrefixes" id="FarcryFormPrefixes" value="#formObj.userObjHash#" />
   <input type="hidden" name="FarcryFormSubmitButton" id="FarcryFormSubmitButton" value="" />
   <input type="hidden" name="FarcryFormSubmitButtonClickedfarcryForm936443538" id="FarcryFormSubmitButtonClickedfarcryForm936443538" value="" />
   <input type="hidden" name="FarcryFormSubmitted" id="FarcryFormSubmitted" value="farcryForm936443538" />
   <input type="hidden" name="SelectedObjectID" id="SelectedObjectIDfarcryForm936443538" value="" />
   <input type="hidden" name="PRIMARYFORMFIELDNAME" value="#formObj.primaryNoHash#aObjectIDs" />
   <input type="hidden" name="FTALLOWLIBRARYADDNEW" value="massMailerUser" />
   <input type="hidden" name="CURRENTPAGE" value="1" />
   <input type="hidden" name="FTLIBRARYPICKLISTSTYLE" value="" />
   <input type="hidden" name="FTLIBRARYSELECTEDLISTCLASS" value="arrayDetail" />
   <input type="hidden" name="FTLIBRARYADDNEWWEBSKIN" value="libraryAdd" />
   <input type="hidden" name="FTLIBRARYPICKWEBSKIN" value="libraryPick" />
   <input type="hidden" name="FTLIBRARYSELECTEDWEBSKIN" value="LibrarySelected" />
   <input type="hidden" name="PACKAGETYPE" value="types" />
   <input type="hidden" name="PRIMARYOBJECTID" value="#formObj.primaryHash#" />
   <input type="hidden" name="FTALLOWLIBRARYEDIT" value="massMailerUser" />
   <input type="hidden" name="WIZARDID" value="" />
   <input type="hidden" name="LIBRARYTYPE" value="array" />
   <input type="hidden" name="PRIMARYTYPENAME" value="massMailerList" />
   <input type="hidden" name="FTLIBRARYPICKLISTCLASS" value="thumbNailsWrap" />
   <input type="hidden" name="PRIMARYFIELDNAME" value="aObjectIDs" />
   <input type="hidden" name="FTJOIN" value="massMailerUser" />
   <input type="hidden" name="FTLIBRARYSELECTEDLISTSTYLE" value="" />
   <input type="hidden" name="librarySection" value="addnew" />
</form>
      
      
         <script type="text/javascript">
            var realeasyvalidation = new Validation('farcryForm936443538', {onSubmit:false});
         </script>
</cfoutput>
<cfsetting enablecfoutputonly="false">

What we have is a call to formtools, supplied with our main object (massMailerList) and our attachment (massMailerUser). This code was wrought from within library.cfm. If you haven't already looked, it would be a great place to learn more about how the open library function works. I don't have any validation for the email field, yet. That's comming down the line.

Hopefully this makes this a little bit clearer. Or, at the very least, steers someone in the right direction.

FarCry plugin breakdown - Part II

First, an addendum. Matthew Bryant pointed out that I had forgetton wrap my objectAdmin tag within an <admin> call. This would explain why my wizzardStep and CSS formating wasn't happening correctly. The updated zip can be found at this location

Let's begin Part II by looking at the customadmin files. These files are responsible for generating the menu at the top of the FarCry administrator, and for providing the links on the left hand pane.

First up, the massMailer.xml:

<?xml version="1.0" encoding="utf-8"?>
<webtop>
   <section mergetype="merge" id="massMailerSection" label="Mass Mailer" labeltype="value">
      <subsection mergetype="merge" id="massMailerSubSection" label="Mass Mailer" labeltype="value">
         <menu mergeType="merge" id="massMailerMenu" label="Mass Mailer" labelType="value">
            <menuitem mergeType="merge" id="massMailer" label="Mass Mailer" link="/admin/customadmin.cfm?module=customlists/massMailer.cfm&amp;plugin=massMailer" />
            <menuitem mergeType="merge" id="massMailerList" label="Mass Mailer List" link="/admin/customadmin.cfm?module=customlists/massMailerList.cfm&amp;plugin=massMailer" />
            <menuitem mergeType="merge" id="massMailerUser" label="Mass Mailer User" link="/admin/customadmin.cfm?module=customlists/massMailerUser.cfm&amp;plugin=massMailer" />
         </menu>
      </subsection>
   </section>
</webtop>

FarCry gives you the ability merge changes to the look and feel of the webtop via XML files. The above should be fairly straightforward to follow.

  • Section - Creates a new tab within the webtop
  • Subsection - Creates the subsection within the specified tab. More than one subsection may be created, and a drop down list of choices will be presented if more than one subsection exists.
  • Menu - The navigation for the subsection
  • Menuitem - Navigation links within the subsection
    • Link - The FarCry custom admin parser
    • Module - The location of your customadmin files. In this case, customadmin/massMailerxxx.cfm
    • Plugin - The name of the plugin for the module

Now, let's look at the files behind the link from above:

<cfsetting enablecfoutputonly="true">

<cfimport taglib="/farcry/core/tags/formtools" prefix="tags">
<cfimport taglib="/farcry/core/tags/admin/" prefix="admin" />

<!--- set up page header --->
<admin:header title="Mass Mailer Admin" />

<tags:objectAdmin
   title="Mass Mailer User"
   typename="massMailerUser"
   ColumnList="label"
   SortableColumns="label"
   lFilterFields="label"
   plugin="massMailer"
   sqlorderby="datetimelastUpdated desc" />


<admin:footer />

<cfsetting enablecfoutputonly="false">

Let's start our simplest object, the massMailerUser. We need to first import the formtools and admin tags. The <admin></admin> tags allows to setup nifty things like pagination, and also bring along page styling. The formtools tags will automagically style the inputs on our pages based on the CFCs we created before. Neat, huh?

We need a call to objectAdmin to display our main menu details. The arguments are:

  • Title - The title displayed at the top of the details page
  • Typename - Very important! This is the type we plan to display
  • Columnlist - Comma seperated list of list columns to display. This could be any column within the type specific database table. Label, action, and datetimecreated are the default
  • SortableColumns - Uh... no further explanation required
  • lFilterFields - Fields on which to allow filters (restrict results)
  • plugin - Plugin to use as a base
  • sqlorderby - Order in which records are displayed in the details page

This set of options should see us through most of what we need to get done. The massMailerList uses much the same call, just a different typename. Things get different for massMailer however.

<cfsetting enablecfoutputonly="true">

<cfimport taglib="/farcry/core/tags/formtools" prefix="tags">
<cfimport taglib="/farcry/core/tags/admin/" prefix="admin" />

<!--- set up page header --->
<admin:header title="Mass Mailer Admin" />

<tags:objectAdmin
   title="Mass Mailer User"
   typename="massMailerUser"
   ColumnList="label"
   SortableColumns="label"
   lFilterFields="label"
   plugin="massMailer"
   sqlorderby="datetimelastUpdated desc" />


<admin:footer />

<cfsetting enablecfoutputonly="false">

There is two things of note here. One is the array of buttons. You can override most of the default behavior of FarCry, and in this case, we need to add the "Send" email functionality. You will need to delve into objectAdmin and typeAdmin to sort out what values are expected here.

The other thing to note is our send functionality. It waits for the form to submit with our "Send" value, then calls to our plugins/massMailer/packages/types/massMailer.cfc with the objectID of the particular massMailer. If you recall from part one, there's a function within our CFC to handle this call, along with the send.cfm file.

Set up muliple instances for just one website - caveats

To expand upon this earlier post, when you map multiple instances within the same website (via virtual webs), items that use CFCHART will break. To make sure that the correct CFIDE is called when calling things like cfform, cfchart, etc. you need to make these modifications (thanks to Bruce Purcell)

  • In {cfmx-root}/lib/neo-graphing.xml
    Change /CFIDE/GraphData.cfm to /somesite/CFIDE/GraphData.cfm
  • In {cfmx-root}/wwwroot/WEB-INF/web.xml
    Change /CFIDE/GraphData.cfm to /somesite/CFIDE/GraphData.cfm

In addition, we were experiencing issues with session replication when users were moving between virtual webs within the same site. The fix for this is to place this code into a normal index.html template, and ensure that this template is called first when entering your site.

<html>
<head>
<script LANGUAGE="JavaScript">
<!--//
       document.cookie = "JSESSIONID=; expires=Thu, 01-Jan-1970 00:00:01 GMT; path=/";
       document.cookie = 'CFID=; expires=Thu, 2 Aug 2001 20:47:11 UTC; path=/';
       document.cookie = 'CFTOKEN=; expires=Thu, 2 Aug 2001 20:47:11 UTC; path=/';
       location.replace('https//<somedomain/<somesite>/index.cfm'); //--> </SCRIPT>

   <!-- <META http-equiv="refresh" content="0;URL=http://<somedomain>/<somesite>/index.cfm" /> -->
</head>
<body>
   <!-- <p>The eBusiness home page can be found at <a href="http://<somedomain>/<somesite>/index.cfm">http://<somedomain>/<somesite>/index.cfm</a></p> -->
</body>
</html>

FarCry plugin breakdown - Part I

I promised a breakdown, and so it shall be writ. This first segment is going to analyze the newly created objects. If I have wherewithal to finish tonight, we'll move along to the administrator addon.

Let's start with our objects then:

  • massMailer - This object will hold all the information about our email. Things like message body, subject, from, to, and the massMailerList objects.
  • massMailerList - This object contains the name of the list, and holds massMailerUser objects.
  • massMailerUser - This object contains the name, email address, and dateTime stamp when the object was created.

Now let's look at the code. We'll start with the massMailerUser.

<cfcomponent extends="farcry.core.packages.types.types" displayname="Mass Mailer Users" bFriendly="1" hint="Mass mailer object to hold the users" bobjectbroker="true" objectbrokermaxobjects="1000">
<!------------------------------------------------------------------------
type properties
------------------------------------------------------------------------->   
<cfproperty ftSeq="11" ftFieldset="User Details" ftWizzardStep="General Details" name="Title" ftLabel="Name" type="string" hint="Users Name" required="no" default="">
<cfproperty ftSeq="12" ftFieldset="User Details" ftWizzardStep="General Details" name="Email" ftLabel="Email" type="string" hint="Email Address" required="no" default="">
<cfproperty ftseq="13" ftFieldset="User Details" ftWizzardStep="General Details" name="DateAdded" type="date" hint="The date user was added" required="yes" default=""ftDefaultType="Evaluate" ftDefault="now()" ftType="datetime" ftDateFormatMask="mm dd yyyy" ftTimeFormatMask="hh:mm tt" ftToggleOffDateTime="false" ftlabel="Date Added" />

<!------------------------------------------------------------------------
object methods
------------------------------------------------------------------------->   
</cfcomponent>

Hmm... so what does THAT mean?? Let's break this object down. Formtools will generate our object administration page for us, but it needs some help to get along.

  • ftSeq - Numeric sequence that you wish the fields to be displayed in
  • ftFieldset - Gives "groups" within a given page. Usually denoted by a horizontal line
  • ftwizardSet - Should give pagination, but it isn't working (for me) at this time
  • name - Name for the object to be created in the database
  • ftLabel - Label to displayed in the admin
  • type - Type for database creation
  • hint - Typical component hint. Although I think there's a way to give context sensitive help, I just haven't explored it yet.
  • required - No need for explanation, right?
  • other ft types - Not going to into these in detail. There are several examples in the core for working with date/time types with the supplied date/time picker.

Next up, our massMailerList object

<cfcomponent extends="farcry.core.packages.types.types" displayname="Mass Mailer List" bFriendly="1" hint="Mass mailer object to create the lists" bobjectbroker="true" objectbrokermaxobjects="1000">
<!------------------------------------------------------------------------
type properties
------------------------------------------------------------------------->   
<cfproperty ftSeq="11" ftFieldset="List Details" ftWizzardStep="General Details" name="Title" type="string" hint="Title of object." required="no" default="">
<cfproperty ftSeq="12" ftFieldset="List Details" ftWizzardStep="General Details" name="aObjectIDs" type="array" hint="Holds objects to be displayed at this particular node. Can be of mixed types." required="no" default="" ftLabel="Users" ftJoin="massMailerUser">

<!------------------------------------------------------------------------
object methods
------------------------------------------------------------------------->   


</cfcomponent>

Pretty much more of the same, EXCEPT, for this little gem. Notice that my aObjectIDs is of type array. This type MUST have an ftJoin attribute applied. You would specify a component here that you would like to have data populated from. In our case it is massMailerUser. But it could easily be dmImage (default supplied image library) or dmFile (default supplied file library). Heck, it can even be a comma separated list of any of these things.

So what happens when you add this type of field? Formtools will generate a button for you to click, called open library. This will pop open a window, and you will be given a choice of various tabs. In the main view, you can drag the massMailerUser (or image, or file, or whatever) objects from the right hand pane to the left hand pane. And that's it, you're done. You've now attached objects as an array to your massMailerList object. And you didn't even have to write any code!

This leaves us with massMailer

<cfcomponent extends="farcry.core.packages.types.types" displayname="Mass Mailer" bFriendly="1" hint="Mass mailer object to send to lists created by Mass Mailer List" bobjectbroker="true" objectbrokermaxobjects="1000">
<!------------------------------------------------------------------------
type properties
------------------------------------------------------------------------->   
<cfproperty ftSeq="11" ftfieldset="Mailer Details" ftWizzardStep="General Details" name="Title" type="string" hint="Title of object." required="Yes" default="">
<cfproperty ftSeq="12" ftfieldset="Mailer Details" ftWizzardStep="General Details" name="aObjectIDs" type="array" hint="FarCry Groups to send email to" required="Yes" default="" ftLabel="Lists" ftJoin="massMailerList">
<cfproperty ftSeq="13" ftfieldset="Mailer Details" ftWizzardStep="General Details" name="fromEmail" type="string" hint="From email address" required="Yes" default="">
<cfproperty ftSeq="14" ftfieldset="Mailer Details" ftWizzardStep="General Details" name="replyTo" type="string" hint="Address(es) to which the recipient is directed to send replies" required="no" default="">
<cfproperty ftSeq="15" ftfieldset="Mailer Details" ftWizzardStep="General Details" name="wraptext" type="string" hint="Specifies the maximum line length, in characters of the mail text." required="no" default="">
<cfproperty ftSeq="16" ftfieldset="Mailer Details" ftWizzardStep="General Details" name="failTo" type="string" hint="Address to which mailing systems should send delivery failure notifications. Sets the mail envelope reverse path value" required="no" default="">
<cfproperty ftSeq="17" ftfieldset="Mailer Details" ftWizzardStep="General Details" name="charset" type="string" hint="Character encoding of the mail message, including the headers" required="no" default="UTF-8">

<cfproperty ftSeq="21" ftfieldset="Text Body" ftWizzardStep="Text Body" name="Body" type="longchar" hint="Main body of content, text only." required="no" default="">
<cfproperty ftSeq="31" ftfieldset="HTML Body" ftWizzardStep="HTML Body" name="htmlBody" type="longchar" hint="Main body of content, to be sent to users as HTML" ftType="richtext"
   ftImageArrayField="aObjectIDs" ftImageTypename="dmImage" ftImageField="StandardImage" required="no" default=""
   ftTemplateTypeList="dmImage,dmFile" ftTemplateWebskinPrefixList="insertHTML"
   ftTemplateSnippetWebskinPrefix="insertSnippet">


<cfproperty name="bSent" type="boolean" hint="Flag for email being sent" required="yes" default="0">


<!------------------------------------------------------------------------
object methods
------------------------------------------------------------------------->   

<cffunction name="send" access="public" output="true" hint="Prepares and sends email to members">
   <cfargument name="objectid" required="yes" type="UUID">
   <cfset stObjMail = createobject("component", application.types.massMailer.packagepath)>
   <cfset massObj = stObjMail.getData(objectid=arguments.objectid)>      
   <cfinclude template="send.cfm">
   
</cffunction>

</cfcomponent>

Again, more of the same. Except we also used a rich text for generation of our "Pretty" email body. Examples of such types exist in the core. Two things worth noting is the send function and the array of massMailerList(s). I plan to fully expound upon this in part II or III, but for now, know that it's there for us when it comes time to send out our mass mail!

Oh, and thank the heavens for FireFox's built in spell checker... it at least keeps these posts from being slightly more legible than I could manage without it.

My First Farcry Plugin... it's done, and here it is

Alrighty. I've created a zip of the plugin, and it will be available from here to download.

Installation instructions:

1) Install the latest version of FarCry Beta from either Jeff Coughlin's site or from the FarCry CMS page. Pertinent installation information can be found at their respective sites.

2) Modify your project//www/Application.cfm so that the plugins list includes massMailer in the list. This is a comma delimited list.

3) Open the FarCry admin and click on the Admin tab. Select COAPI from the dropdown list, and then click types. Deploy the three massMailer types. Next click rules, and deploy the massMailer rule.

Usage

Example 1: You want to have a form add a user to an email distribution list.

1) Open the FarCry admin and click on the Mass Mailer tab.

2) Click (in the left hand pane) the Mass Mailer List to create a new list.

3) Click Add to create a new List. Each List has two properties, a name, and a list of emails. We'll only worry about the name for now. Give the List a name, and Save.

4) Open a window to view your FarCry site. Switch to Design Mode, and click on a container where you'd like the new form to reside.

5) Choose the Mass Mailer Rule from the list, and add it to the container using the Commit button. This should take you to the next step. From here, select the Display Method (one is supplied for you), and use the Open Library to add a list. You can add only one list per rule! I'm thinking of modifying this in the future, but for now it stays. Save the results.

6) Refresh the page, and you should now see a form containing the Name and Email fields. Complete the form, and once submitted, it will add a new entry to your list (as well as create a new massMailerUser object). To verify, open the FarCry admin/Mass Mailer Tab and edit the Mass Mailer List you just created.

Example 2:

1) Follow steps 1-3 above. While still in the open library, you can choose to attach a new object.

2) Otherwise, click Mass Mailer User, add the new user, and then attach using the open library from Mass Mailer List.

Sending Mail

1) Open the FarCry admin, and click the Mass Mailer tab.

2) Click on the Mass Mailer link in the left hand pane. And then click Add from the top navigation.

3) Fill out the form fields as required. You need, at minimum, the Subject and List (open library). You can add as many lists as you like to the email.

4) There is a plan to add an attachment to the emails, but that's slated for the next release.

5) Save the object. Then select the object, and from the top/central navigation buttons, click Send.

The end! Tomorrow (or as time permits) I'll break down the objects and the "Why" of it.

My First Farcry... well, plugin is the term now, take 3.1

Alright. We have successful email creation in place. You can also assign a rule and a webskin to the rule. The final piece is adding the massMailerUser object to the massMailerList object via an online form. This should be completed tonight, family willing, and I'll start the break down/analysis of what each file does, and why. Thank you ray for the use of code tags, which ya'll will see extensive use of tomorrow ;).

Update: so close to the finish I can almost taste it... however, it's late. I need to sit in on performance tests tomorrow morning, so it will need to wait until tomorrow afternoon to finish up. The good news, though, is it works! I need to cull the deadwood of copied functions from the core/admin/facade/library.cfm that will not be used, but it appears that everything is working as it should. Yay!

My First FarCry library take 3

I finally got some free time to move this project towards completion. And then things went to heck in a handbasket when Daemon decided to change around the code base ;). So, what has changed is that farcry_core is now just core. Projects have moved to a projects folder. And farcry_lib is now plugins. That last is what really affected me. I had to change my customadmin and customlists to reflect this change.

As Stephen mentioned in previous comments, Formtools is just too sexy for itself. I went the easy route for the time being, but will climb the hard road in time.

My three objects still exist, one calling the other using the open library feature of Formtools. The only drawback I can fore see is there is no way to select multiple objects at a time. I'll see if anyone has extended this yet. This is now working smashingly.

Next up, setup the special columns required to send mail through the admin. Then, finally, adding users to lists via the web signup form.

Update: And we have success! You now create a user. Assign the user to a list(s). Assign that list to an email to be distributed, and then send. Full source to be fourth coming as soon as the rule (which can be dropped into a page) and webskin templates are setup. Maybe tonight, maybe tomorrow.

Update 2: The rule for adding the massMailer to a page has been created (which was pretty simple). Now the tough part... adding the formtools functionality to the webskin. Since we're attaching a new objectid into the massMailerList object, seems to be the most practical way of doing so. Of course, we could do it by straight database manipulation, but where's the fun in that ;).

My First FarCry library take 2

So, I'm going to need three different objects to accomplish this task. One massMailer, massMailerList and massMailerUser. The massMailer object is the main object, and it contains fields for From, Body, To (shown as a dropdown, but really a link to the massMailerList object), etc. The massMailerList object contains a title, and an array of massMailerUser objects. The massMailerUser object contains things like name, email, date added. Whew. These objects have been deployed, and their associated table data has been created.

Next up, creating the display methods and tweaking code so that Formtools displays the object properties correctly. However, given the lateness of the hour, it's not happening tonight.

Update: Sorry to those who are watching in anticipation of an early completion. Due to sick family members, I can't really finish this up until tomorrow night. On that note... sleep awaits.

Next up on deck... My First FarCry lib!

I'll add to this post, hopefully to completion, tomorrow. At one point, I had a fairly decent mass mailer set up in FarCry 2.x/3.x. I left that employer but still have most of the code required. It was a modification of the dmEmail object to allow for the a list of emails to be inserted into a variable via CFFILE. You'd upload the list to the server, then import said list to an array.

So, I'm working on site for my son's preschool, and it would be helpful to have similar functionality. But, with a twist. I want the library to capture emails into subscription pools, then use these pools to send out the various emails. The idea being that those looking to get updates from the preschool will join one (or more) of the mailing lists, then receive updates based on the list that was joined. I'll be placing this into the new FarCry 4.0 library feature and making the code available here, and on the FarCry lists/wiki.

Update: I've seriously underestimated this task. Much has changed under the hood of FarCry that I'm only just getting back into. At the moment, the extension to formtools has been created. Dang is that a cool new feature ;). I've got the main display item for Mass Mail distribution 90% complete. But, I've run into an issue of making aObjectIDs for the underlying list emails that gets called. This has REALLY changed, and will take a little more time to deconstruct. It's late, I'm off for now.

Update2: Please bear with me. There's not much going to be accomplished today. I'll try finishing up tonight, but we'll take the day as it comes.

Installing FarCry as a virtual site in IIS

This is specific to the FarCry 4.0 release. At the time of this writing, you can grab it from http://www.jeffcoughlin.com/?pg=11. From this site, be sure to get farcry_core, fourq, farcry_mollio, farcry_lib.farcrycms.

First, our directory structure. Unzip the zips into
C:\farcry40\farcry_core
C:\farcry40\fourq
C:\farcry40\farcry_mollio
C:\farcry40\farcry_lib\farcrycms

You will need to create a project folder. Create a copy of farcry_mollio, and place it into either: C:\farcry40\somesite Or C:\websites\somesite

If the folder is placed outside of the FarCry root, additional steps will need to be followed. Those steps will be listed below. Follow the steps below to complete the installation. Please note that the folder paths used are merely provided as an example.

  1. Open the IIS administrator. Add the virtual site somesite off of your main domain website. Eg. Mainsite.com/somesite. To do this, right click the website to modify, and click New->Virtual Directory.
  2. Fill in the Alias as somesite, click Next. Path will be either C:\farcry40\somesite\www, or the optional folder outside of farcry at C:\websitse\somesite\www.
  3. Choose access permissions as appropriate for your environment. Click Next then Finish to continue.
  4. Create a new virtual directory in a similar fashion for farcry. Right click the newly created somesite folder and click New->Virtual Directory. The alias is farcry and the path is C:\farcry40\farcry_core\admin.
  5. Create a new database user/schema/database/etc to hold the FarCry table information. This document is database agnostic, and assumes the user has some means of affecting these changes. Regardless, FarCry should have its own schema/database to reside in.
  6. Log into the ColdFusion (CF for short) administrator and create mapping for a logical path of /farcry and directory path of C:\farcry40.
  7. Optional - if the project folder is outside of the FarCry folder, create a mapping for a logical path of /farcry/somesite and a directory path of C:\websites\somesite.
  8. Create a new CF datasource called somesite_farcry pointing to the database/schema created in step 5.
  9. And, this was submitted to the FarCry list... change somesite\www\install\FlightCheck.cfc to:
    <cfinclude template="/#arguments.siteName#/install/ping/index.cfm" />
  10. At this point you should now be ready to run the FarCry installation scripts. Open a browser to mainsite.com/somesite/install. If running from somewhere other than localhost, be sure to edit C:\farcry40\somesite\www\install\Application.cfm (or C:\websites\somesite\www\install\Application.cfm) to reflect your IP.
  11. Fill in the required fields. The application name must match the folder name you've created. In this case it is somesite. Fill in the DSN name, and the database type. The website mapping should be /somesite and the FarCry mapping should be /somesite/farcry. Choose to install the farcrycms library, and if in production, remove the installation folder.
  12. At this point, everthing should be ready to go. Click Install and watch the output of the screen. If any errors occur, either report them back to the FarCry mailing list, or investigate where the installer indicates there to be a problem.
  13. Add this line to somesite\config\_serverSpecificVars.cfm: <cfset application.url.webroot = "/somesite">

FarCry installation on a linux/Plesk shared host

First, just a little “this is WHY we do this” (and only a little, I promise!).  Everyone seems to get a touch freaked out when going over the FarCry install and its various mappings.  The thing to keep in mind is that the mappings and folder structure exist because FarCry relies heavily upon CFCs and extension of these CFCs.  Even your site, eg. “Project”, relies upon being able to map to these CFCs in a preordained fashion.  The easiest way to pull this off is to have everything reside inside the main FarCry root.

Now, that was the 3.0 and lower builds.  FarCry 4.0 introduced the ability to have the “Project” folder reside completely separately from the FarCry core.  Or, at least that’s my understanding from the new features document.  I’ve not tried this with 3.x (but I do have another method for that!)  Anyway, if this is done, you must make sure that you create a CF mapping to these files in a way that FarCry can reach them.  Since FarCry assumes that the “Project” folder resides in the FarCry root, you need to make a CF mapping that imitates that.  Thus, you need to make the normal CF mapping for FarCry (something like /farcry c:\farcry40) and a mapping to your site, pre-pending farcry to it (/farcry/somesite c:\websites\somesite).  This mapping MUST match what you called the site when installing FarCry.  So, a call to farcry.somesite.whatever will work correctly.  All is good with the universe.

So let’s do an example of this for FarCry 4.0 and the linux shared host out on the interweb using Plesk. 

  1. Upload FarCry (and all of it’s supporting libraries farcry_core, fourq, farcry_lib) to one of your domains httpdocs directory.  Doesn’t matter which, really.  One you know will not be deleted.  Ever.
    eg /home/httpd/vhosts/mainsite.com/httpdocs/farcry40
  2. Ask the CF admin of your box to create a CF mapping like:
    /farcry /home/httpd/vhosts/mainsite.com/httpdocs/farcry40
  3. Upload the mollio template (renamed to somesite) to the domain that will be hosting a FarCry site:
    /home/httpd/vhosts/somesite.com/httpdocs/somesite
  4. Ask the CF admin of your box to create a CF mapping like:
    /farcry/somesite /home/httpd/vhosts/somesite.com/httpdocs/somesite
  5. Now, this is really, REALLY handy.  Ask the CF admin to create a vhost.conf file for your somesite domain.  This file will never be over written by Plesk and can be used to override the values Plesk sets.  The file should contain:
    DocumentRoot "/home/httpd/vhosts/somesite.com/httpdocs/somesite/www"
    Alias /farcry /home/httdp/vhost/mainsite.com/httpdocs/farcry40/farcry_core/admin
  6. Create a database to hold your FarCry information, and ask the CF admin to create DSN pointing to this database
  7. Once Plesk gets restarted, browse to www.somesite.com/install and fill in the values as required.  App name in this case is “somesite”, and the project web mapping and farcry web mapping should not be changed.  Click install once all fields are complete
  8. Repeat per domain as necessary. Make sure everyone and every group can write into the FarCry plp and tmp directories.

Now let’s do an example of this for FarCry 3.1 and the linux shared host out on the interweb using Plesk

  1. Upload FarCry (and all of it’s supporting libraries farcry_core, fourq) to one of your domains httpdocs directory.  Doesn’t matter which, really.  One you know will not be deleted.  Ever.
    eg /home/httpd/vhosts/mainsite.com/httpdocs/farcry31
  2. Ask the CF admin of your box to create a CF mapping like:
    /farcry /home/httpd/vhosts/mainsite.com/httpdocs/farcry31
  3. Upload the mollio template (renamed to somesite) to the farcry31 directory:
    /home/httpd/vhosts/mainsite.com/httpdocs/farcry31/somesite
  4. Now, this is really, REALLY handy.  Ask the CF admin to create a vhost.conf file for your somesite domain.  This file will never be over written by Plesk and can be used to override the values Plesk sets.  The file should contain:
    DocumentRoot "/home/httpd/vhosts/mainsite.com/httpdocs/farcry31/somesite/www"
    Alias /farcry /home/httdp/vhost/mainsite.com/httpdocs/farcry31/farcry_core/admin
  5. Create a database to hold your FarCry information, and ask the CF admin to create DSN pointing to this database
  6. Once Plesk gets restarted, browse to www.somesite.com/farcry/install and fill in the values as required.  App name in this case is “somesite”, and the project web mapping and farcry web mapping should not be changed.  Click install once all fields are complete
  7. Repeat per domain as necessary.  Make sure everyone and every group can write into the FarCry plp and tmp directories.  Make sure everyone and every group can read farcry directories.

The end! I much prefer the first method since it means each domain has its own files reside within the normal directory struture. Much more secure, much easier to manage. Better all around.

How to set up muliple instances for just one website

Now, I'm going to preface this with a note. If you multiple websites (eg multiple domains), you are in a much better position than I am. There are caveats to watch out for with multiple instances for just a single site, which will be detailed later on.

My day job is working as a government contractor, and the clients in our shared environment are only given virtual directories off the main domain root. And we're talking about about 50 total applications.

After (finally) getting FusionReactor installed in-house, we have started finding a trend about which applications have been causing problems with our environments. Since we were already using CF installed as J2EE applications, we decided to pull the trouble application into its own instance.

Now, we don't have much clout when it comes to making changes within the environments, so moving this one site into its own domain would/will require lots of paper work, approvals, and time. However, customers don't won't to hear an answer like that, so we came up with a way to work within the system, but didn't require moving a mountain.

So, the steps to get you where you're going:

  • First, I usually have a default cfusion-ear file waiting to roll. However, making a copy of your existing cfusion-ear works fine as well. Create a new folder within your {jrunroot}/servers directory for this new instance. We'll call it instance2. Copy the cfusion-ear file into this directory.
  • Log into the JMS, or click the ColdFusion Enterprise Manger if you have CFMX 7 installed in multiserver mode. Create a new instance and give it the same name as the folder you just created. So, instance2 for example.
  • If this is part of a cluster (mine are), create an instance on the other machine(s). CAUTION: Make certain that each instance, if it's to be part of a cluster, MUST have a unique name. I did not know this until it bit me and caused all kinds of replication issues.
  • If this is part of a cluster, create the cluster and add the instances. Otherwise, skip this step.
  • Start IIS admin (I haven't tested this on apache yet) and create a new website. Doesn't really matter where it points to, or the port that it exists on. This has been tested on IIS 5/6.
  • Start up the JRun website configurator. I generally call the jar file directly as the default JVM is 1.3 on our systems, where the ColdFusion JVM is 1.4 which is required. Add a new site, and select the instance/cluster you just created and map it to the website you just created. Make sure to check to the box to install the ColdFusion connector.
  • You now have a new numbered directory in {jrunroot}/lib/wsconfig. You can now map the virtual directory to use this connector instead of the default connector. Open the properties of the virtual directory, select Configuration from the Directory tab. If you're using IIS 6, you can merely change the filter in one spot. If you're using IIS 5, you need to change the filter for each CFM type file.


Restart IIS and you should be good to go. So how do you know it's working? Well... you could install SeeFusion or FusionReactor. You could check the HTML headers to verify the JSESSIONID. The first four characters should match the {jrunroot}/servers/{instance}/server-inf/connector.properties. You could put code into your application that makes a call to serviceFactory that reports the instance information. And on and on.

So, the caveats:

  • Doing this WILL break CFCHART. In fact, anything that makes a call to /CFIDE that is interpreted by the web.xml file will be affected. There is a solution to this, and it will be the subject of my next blog post
  • You might have issues if you use session replication if the instances are in clusters. Let me give you an example. User visits your www.somesite.com/whatever. There is a link from there to the site in its newly created instance. The JESSIONID from the /whatever site still exists. Uh oh. You'll receive errors about failed session replication in the logs, and the user will get round-robined across the new cluster. This is especially a pain if there is any session information holding user values. The information will not be propagated across the cluster, and the users session will appear to be timed out. The only solution I've found to this is to either destroy the JESSIONID cookie, or pull the instance into its own website.