openForms/list_base.hpp

Go to the documentation of this file.

#ifndef LIST_BASE_HPP
#define LIST_BASE_HPP

#include <iostream>
#include <iomanip>
#include "ocTypes.h"
#include "ocString.h"
#include "read_base.hpp"
#include "cgiClass.h"
#include "cgiTemplates.h"
#include "cgiCookie.h"

#define DEBUGOUT

typedef map <string,string> courtesy_args;

class list_base: public read_base
{
protected:
  cgiTemplates listTemplate;
  cgiScript & webIO;
  cgiCookie cookie;
  courtesy_args crtsy_args; // deprecated
  ocString td; 
public:
  bool opened;
  ocString editLink;
  int hotCol;
  int skipCol;
  string addedCriteria;
  
  /* 
    Use this to to place 
    hidden form fields within a form 
  */
  string courtesyFormFields( void ) // deprecated
  {
    string ret;        
    courtesy_args::iterator pos;    
    for( pos=crtsy_args.begin();pos!=crtsy_args.end();++pos)
    {
      ret+="<input type='hidden' name='";
      ret+=pos->first;
      ret+="' value='";
      ret+=pos->second;
      ret+="'>";
    }
    return ret;
  }
  
  /*
    Use this to complete the query string of a URL
    Use the start arg to input the ? or & whichever is needed.
    Caller should know!
  */ 
  string courtesyQueryString( string start = "" ) // deprecated
  {     
    bool started=false;
    string ret = start;
    courtesy_args::iterator pos;
    for( pos=crtsy_args.begin();pos!=crtsy_args.end();++pos)
    {
      if(started) ret+="&";
      ret+=pos->first;
      ret+="=";
      ret+=pos->second;
      started = true;
    }
    if(!started) ret="";
    return ret;    
  }
  
  // for filtering, sorting, and page;
  string cookiePrefix;  
  string filter, sort, direction; 
  int  listPg, itemsPerPg, recCount, colCount, pgCount, dsetCount;
  
  /* 
    This is for any external list setup form 
    to be able to persist it's settings
  */  
  void addCourtesyArg( string name, string value = "" ) // deprecated
  {
    crtsy_args[name] = value;
  }  
  void setPage( cgiInput & args )
  {
    listPg = atol(cookie.get("lPg").c_str()); 
    if (args.count("Pg") )
    {
      listPg = (atol(args["Pg"].c_str())-1);      
    }
    else if(args.count("navigate") )
    {
      if( args["navigate"] == "prev" ) listPg--;
      if( args["navigate"] == "next" ) listPg++;
    }
    if( listPg < 0 ) listPg = 0;    
  }
  string limitClause( void )
  {
    int rowStart = listPg * itemsPerPg;
    ocString limit = " limit ";
    if( db.getProvider() == MySQL )
    {
      limit.append(rowStart);
      limit += ", ";
      limit.append(itemsPerPg);
    }
    else if( db.getProvider() == PostGresQL )
    {
      limit.append(itemsPerPg);
      limit += " offset ";
      limit.append(rowStart);     
    }
    return limit;
  }
  void setSort( cgiInput & args )
  {
    direction = cookie.get("lDir");
    sort = cookie.get("lSort");
    // has the order been specified?
    if (args.count("sort") )
    { 
      if(  sort == args["sort"].c_str() )
      {
        // reverse direction
        direction = direction=="desc"?"asc":"desc";
        cookie.set("lDir",direction.c_str());
      }  
      sort = args["sort"].c_str();
      cookie.set("lSort",sort.c_str());
    }
  }
  /*
    reset is called by the constructor.
    initial calls to a page with list_base deived lists should call
    the page with the query string having init=1 
    (init=anything at all really, but 1 by convention)
  */
  void reset( cgiInput & args )
  {
    if( args.count("init") ) 
    {
      // kill all the other list cookies!
      cookie.set("lFilter","");
      cookie.set("lDir","");
      cookie.set("lSort","");
      cookie.set("lPg",""); 
    }  
  }
  /*
    Looks for a 'filter' argument to place filter commands in the 
    'where' clause by replacing "$filter$" in the template parameter 
    'filterTemplate' of the 'getFilteredData()' method.
    Additionally sets a session cookie "lFilter" for persistence.
  */      
  void setFilter( cgiInput & args )
  {
    if( webIO.RequestMethod().upper() == "GET" )
    {
      filter = cookie.get("lFilter");
    }  
    if( args.count("filter") )
    { 
      filter = args["filter"].c_str();
      cookie.set("lFilter",filter.c_str());      
    }
  }
  /*
     This constructor must be called!
     Call it before closing the script header!
  */   
  list_base(cgiScript&sc):read_base(),webIO(sc),opened(false),hotCol(0),skipCol(-1)
  ,listPg(0), itemsPerPg(20), recCount(0), colCount(0)
  ,pgCount(0), dsetCount(0)
  {
    cgiInput & args = sc.ClientArguments(); 
    reset( args ); 
    // set and cache the current sort order  
    setSort( args ); 
    // set and cache the current filter
    setFilter( args );  
    // set and cache the current page of data 
    setPage( args );             
  }
  
  virtual ~list_base(){;}
  // load template for forms controls
  bool loadListTemplates( string path )
  {
    return listTemplate.load(path.c_str());
  } 
  list_base & copyListTemplates( const cgiTemplates & in )
  {
    listTemplate = in;
    return * this;
  } 
  bool getData( string sql )
  {
    opened = rs.open(sql);
    if( opened )  recCount = rs.getRecordCount();  
    return opened;
  }
  
  string whereClause( ocString & filterTemplate )
  { 
    string sql = "";
    if( filter.length() )
    {
      filterTemplate.parseInit();
      sql += " where ";
      ocString filterParts = filter;
      string filterPart = filterParts.parse("|");
      ocString filterTemp = filterTemplate.parse("|");
      do 
      {
        sql += filterTemp.replace("$filter$", filterPart.c_str() );
        filterTemp = filterTemplate.parse("|");
        filterPart = filterParts.parse("|");
        if(sql.length()&&filterTemp.length()) sql += " and ";
      } while( !(filterTemplate.endOfParse() && filterTemp.length()==0) );      
    }
    if( addedCriteria.length() )
    {
      sql += ( filter.length() ) ?  " and " : " where ";      
      sql += addedCriteria;
    }    
    return sql;
  }
  
  void maxPageFixup( void )
  {
    pgCount = (recCount/itemsPerPg)+1;
    if( listPg >= pgCount ) listPg = pgCount-1;       
  }
  bool getFilteredData( string rows, 
                        string table,
                        ocString filterTemplate, 
                        string defaultSort = "",
                        string groupBy = "",
                        string countTable = "" ) // for cases where grouping limits the real count.
  {
  
    string sql = "select count(*) from ";
    sql += countTable.length()?countTable:table;    
    sql += whereClause( filterTemplate );
#ifdef DEBUGOUT
    webIO << "<!--" << sql << "-->";
#endif
    opened = rs.open(sql);
    if( opened )
    {
       recCount = atol(rs.getField(0).format().c_str());
       maxPageFixup();
       rs.close();
    } 
     
    sql = "select ";
    sql += rows;
    sql += " from ";
    sql +=  table;
    sql += whereClause( filterTemplate ); 
    if( groupBy.length() )
    {
      sql += " group by ";
      sql += groupBy;
    }   
    if( sort.length() ) 
    {
      sql += " order by ";
      sql += sort;
      sql += " ";
      sql += direction;
    }
    else if ( defaultSort.length() )
    {
      sql += " order by ";
      sql += defaultSort;
    }
    sql += limitClause();
#ifdef DEBUGOUT    
    webIO << "<!--" << sql << "-->";
#endif    
    opened = rs.open(sql);    
    if( opened )
    {
      dsetCount = rs.getRecordCount();      
    }
    return opened;
  }    
  list_base & emitFilter( string program, string label )
  {
    string value;
    if( webIO.ClientArguments().count("filter")  )
    {
      value = webIO.ClientArguments()["filter"].c_str();
    }  
    ocString filterform = listTemplate.getParagraph("list_filter");
    if( program.find("?") != string::npos ) 
    {
      filterform = filterform.replace("?","&");
    }  
    webIO << filterform.replaceAll( "$location", program.c_str())
                       .replaceAll("$label",label.c_str())
                       .replace("$value", value.c_str() );  
  }
  
  list_base & emitFilters( string program, ocString labels )
  {
    ocString values;
    if( webIO.ClientArguments().count("filter")  )
    {
      values = webIO.ClientArguments()["filter"].c_str();
    } 
    ocString fstart = listTemplate.getParagraph("multi_filter_start");
    ocString fitem = listTemplate.getParagraph("multi_filter_item");
    ocString fend = listTemplate.getParagraph("multi_filter_end");
    
    if( program.find("?") != string::npos ) 
    {
      fstart = fstart.replace("?","&");
    }
    webIO << fstart.replaceAll( "$location", program.c_str());
    ocString label = labels.parse("|");
    ocString nlabel = label.parse(":");
    string typeSection = label.parse(":");
    string value = values.parse("|"); 
    do
    {

      if(typeSection.length())
      {
        ocString fAltItem = listTemplate.getParagraph(typeSection);
        webIO << fAltItem.replaceAll("$label",nlabel.c_str()).replace("$value", value.c_str() );
      }
      else
      {
        webIO << fitem.replaceAll("$label",label.c_str()).replace("$value", value.c_str() );
      }
      value = values.parse("|");
      label = labels.parse("|");
      nlabel = label.parse(":");
      typeSection = label.parse(":");
    } while ( ! (labels.endOfParse() && label.length()==0) );
    
    webIO <<  fend.replaceAll( "$location", program.c_str());
  }
  list_base & emitHeadings( string pipedelimited )
  {
    ocString headings(pipedelimited);
    string list_begin = listTemplate.getParagraph("list_begin");
    string tr = listTemplate.getParagraph("tr");
    ocString th = listTemplate.getParagraph("th");
    string end_tr = listTemplate.getParagraph("end_tr");
    webIO << list_begin << tr;
    while( ! headings.endOfParse() )
    {
      colCount++;
      string heading = headings.parse("|");
      webIO << th.replace( "$data$", heading.c_str() );
    }    
    webIO << end_tr;
    return * this;
  }
  list_base & emitNavigation( string program  )
  {
    ocString numcols, curPage, numPages,datasetCount,recordCount;
    numcols.append(colCount);
    curPage.append(listPg+1);
    numPages.append(pgCount);
    datasetCount.append(dsetCount);
    recordCount.append(recCount);
    
    ocString nav = listTemplate.getParagraph("list_nav");
    if( program.find("?") == string::npos )
    {
      nav = nav.replaceAll("$cols",numcols.c_str())
        .replaceAll("$location",program.c_str())
        .replace("$Page",curPage.c_str())
        .replace("$total$",numPages.c_str())
        .replace("$dsetCount", datasetCount.c_str())
        .replace("$recCount", recordCount.c_str()); 
    }
    else
    {
      program += "&";
      nav = nav.replaceAll("$cols",numcols.c_str())
       .replaceAll("$location?",program.c_str())
       .replace("$Page",curPage.c_str())
       .replace("$total$",numPages.c_str())
       .replace("$dsetCount", datasetCount.c_str())
       .replace("$recCount", recordCount.c_str()); 
    }   
    if( crtsy_args.size() ) // deprecated
    {
      string qryRep = courtesyQueryString( "prev&" );
      nav = nav.replace( "prev", qryRep.c_str() );
      qryRep = courtesyFormFields();
      nav = nav.replace("<!--hiddenfields-->",qryRep.c_str() );
      qryRep = courtesyQueryString( "next&" );
      nav = nav.replace( "next", qryRep.c_str() );
    }
    webIO << nav;       
    return * this;   
  }
  
  list_base & emitEnd( void )
  {    
    ocString list_end = listTemplate.getParagraph("list_end");
    ocString lPg;
    lPg.append(listPg);     
    webIO << list_end.replace("$lpg",lPg.c_str()); 
    return * this;  
  }
  
  void setColFormat( string fmt, int pos )
  {
    if( pos < rs.getFieldCount() )
    {
      rs.getField(pos).setFormatMask(fmt);
    }
  }
  
  list_base & emitData( void )
  {
    bool more_data = opened;
    string tr = listTemplate.getParagraph("tr");
    td = listTemplate.getParagraph("td");
    string end_tr = listTemplate.getParagraph("end_tr");
    int fieldCount;
    if( opened ) fieldCount = rs.getFieldCount();
    derived_commence_event();
    while( more_data )
    {
      if( derived_predata_event() )
      {
        webIO << tr;
        for( int i=0; i < fieldCount; ++i )
        {
          if( i == hotCol || hotCol == -2 )
          {
            sendHotField(i, td );  
          }
          else if( i != skipCol )
          {
            sendField(i, td ); 
          }  
        }       
        webIO << end_tr;
      }
      derived_data_event(); 
      more_data = rs.next();  
    }
    dsetCount = rs.getRecordCount(); 
    derived_complete_event();
    return * this;
  }
  
  // To be able to override each field
  virtual void sendField( int iField, ocString & td )
  {
    webIO << td.replace( "$data$", rs.getField(iField).format().c_str() ); 
  }
  
  // to be able to override the hot column (the one with the link.)
  virtual void sendHotField( int iField, ocString & td )
  {
    webIO <<  td.replace( "$data$",
                    editLink.replaceAll( "$key$",rs.getField(0).format().c_str())
                            .replaceAll( "$col$",rs.getField(iField).format().c_str()).c_str());
  }
    
  // events
  virtual void derived_commence_event( void ){;}
  virtual bool derived_predata_event( void ){ return true; }
  virtual void derived_data_event( void ){;}
  virtual void derived_complete_event( void ){;}
};

#endif

---