*
* (WebLearn modification (method added): 02/12/2003 Colin Tatham) * @param original_resource The resource with content to copy. * @param new_resource The resource to copy content to. * @exception BuildingServerException Thrown if there is any problem copying the resource content. * @exception RemoteException Thrown if there is any problem copying the resource content. * */ private void copyAuthoredContent( Resource original_resource, Resource new_resource ) throws BuildingServerException, RemoteException { LogBookSession session; LogBookSection[] sections; LogBookQuestion[] questions; PrimaryKey section_id; LogBookSection new_section; LogBookQuestion new_question; session = (LogBookSession)BuildingSessionManagerImpl.getSession( original_resource ); sections = session.getSectionsInOrder(); for (int i=0; i < sections.length; i++) { new_section = new LogBookSection(); new_section.setLogBookId( new_resource.getPrimaryKey() ); new_section.setTitle( sections[i].getTitle() ); new_section.setIntroduction( sections[i].getIntroduction() ); new_section.setOrdinal( sections[i].getOrdinal() ); new_section.save(); section_id = sections[i].getLogBookSectionId(); questions = session.getQuestionsInOrder( section_id ); for (int j=0; j < questions.length; j++) { new_question = new LogBookQuestion(); new_question.setLogBookSectionId( new_section.getLogBookSectionId() ); new_question.setQuestion( questions[j].getQuestion() ); new_question.setTitle( questions[j].getTitle() ); new_question.setHelp( questions[j].getHelp() ); new_question.setOrdinal( questions[j].getOrdinal() ); new_question.save(); } } } /** * Parses form data from a create new logbook form to validate user input. * * @param breq The Request object from which form parameters can be read. * @param out Writer to which user input validation messages can be sent adivsing * the user how to correct their selections. * @return Returns true if all is OK or false if the input is invalid. */ public boolean createCheck( Request breq, PrintWriter out ) { // There is only one boolean to check - it's empty or has a value to // indicate true/false so it can't have invalid values. So always // return true. return true; } public boolean generateFile( Request req, HttpServletResponse res ) throws ServletException, IOException { // generate a file, or select a previously generated file if ( req.getPageName().equals( "questions.csv" ) ) { return generateCsvQuestionFile( req, res ); } return super.generateFile( req, res ); } public boolean generateCsvQuestionFile( Request req, HttpServletResponse res ) throws ServletException, IOException { try { BuildingSession session; LogBookSession lb_session; session = BuildingSessionManagerImpl.getSession( req.getResource() ); if ( !(session instanceof LogBookSession) ) throw new ServletException( "Unexpected problem generating file." ); lb_session = (LogBookSession)session; lb_session.generateCsvQuestionFile(); res.setContentType( "text/plain" ); return true; } catch ( BuildingServerException bsex ) { log.error(bsex.getMessage(), bsex ); } return false; } public void insert( Request req, PrintWriter out, String command, String insertname ) throws ServletException, IOException { try { BuildingSession session; LogBookSession lb_session; session = BuildingSessionManagerImpl.getSession( req.getResource() ); if ( !(session instanceof LogBookSession) ) { out.println( "
User wasn't specified
" ); return; } User viewer = (User)BuildingContext.getContext().getUser(); LogBookPage page = lb_session.getPageForUser( user_id ); if ( page == null ) return; req.setSwitchedOff( page.getUserId().equals( viewer.getPrimaryKey() ) ); return; } // True if the user could create a private entry, i.e. if they own the page. PJC 2004-04-08. if ( command.equalsIgnoreCase( "allowsprivate" ) ) { PrimaryKey user_id = getUserId( req ); if ( user_id == null ) { out.println( "User wasn't specified
" ); return; } User viewer = (User)BuildingContext.getContext().getUser(); LogBookPage page = lb_session.getPageForUser( user_id ); if ( page == null ) { // If the current user would be the owner of the created log book, they can create private entries. PJC 2004-07-19. req.setSwitchedOff( !viewer.getPrimaryKey().equals( user_id ) ); return; } req.setSwitchedOff( !page.getUserId().equals( viewer.getPrimaryKey() ) ); return; } // True if the user could create a private entry, i.e. if they own the page, but this entry is new or not private. PJC 2004-04-08. if ( command.equalsIgnoreCase( "allowsbutisnotprivate" ) ) { PrimaryKey user_id = getUserId( req ); if ( user_id == null ) { out.println( "User wasn't specified
" ); return; } User viewer = (User)BuildingContext.getContext().getUser(); LogBookPage page = lb_session.getPageForUser( user_id ); if ( page == null ) { // If the current user would be the owner of the created log book, they can create private entries. PJC 2004-07-19. req.setSwitchedOff( !viewer.getPrimaryKey().equals( user_id ) ); return; } PrimaryKey entry_id = getEntryId( req ); LogBookEntry entry = null; if ( entry_id!=null ) entry = lb_session.getEntry( entry_id ); if ( entry == null ) { req.setSwitchedOff( !page.getUserId().equals( viewer.getPrimaryKey() ) ); return; } req.setSwitchedOff( entry.isPrivate() || !page.getUserId().equals( viewer.getPrimaryKey() ) ); return; } // 'public' actually means 'neither private nor draft' if ( command.equalsIgnoreCase( "ispublic" ) ) { PrimaryKey entry_id = getEntryId( req ); LogBookEntry entry = null; if ( entry_id!=null ) entry = lb_session.getEntry( entry_id ); if ( entry == null ) { req.setSwitchedOff( true ); return; } req.setSwitchedOff( entry.isPrivate() || entry.isDraft() ); return; } // True if the user can upload files. At present, this is true iff they own the page. PJC 2004-04-14. if ( command.equalsIgnoreCase( "allowsattachments" ) ) { PrimaryKey user_id = getUserId( req ); if ( user_id == null ) { out.println( "User wasn't specified
" ); return; } User viewer = (User)BuildingContext.getContext().getUser(); LogBookPage page = lb_session.getPageForUser( user_id ); if ( page == null ) { // If the current user would be the owner of the created log book, they can upload. PJC 2004-07-20. req.setSwitchedOff( !viewer.getPrimaryKey().equals( user_id ) ); return; } req.setSwitchedOff( !page.getUserId().equals( viewer.getPrimaryKey() ) ); return; } if ( command.equalsIgnoreCase( "islogclosed" ) ) { PrimaryKey user_id = getUserId( req ); if ( user_id == null ) { out.println( "User wasn't specified
" ); return; } LogBookPage page = lb_session.getPageForUser( user_id ); if ( page == null ) req.setSwitchedOff( true ); else req.setSwitchedOff( !page.isClosed() ); return; } if ( command.equalsIgnoreCase( "canpost" ) ) { // here it just checks post access and if the page is closed // but when the user // acutally tries to post messages more checks are made PrimaryKey user_id = getUserId( req ); if ( user_id == null ) { out.println( "User wasn't specified
" ); return; } LogBookPage page = lb_session.getPageForUser( user_id ); if ( page == null ) req.setSwitchedOff( !req.getResource().checkPermission( Permission.POST ) ); else req.setSwitchedOff( !(req.getResource().checkPermission( Permission.POST ) && !page.isClosed()) ); return; } if ( command.equalsIgnoreCase( "canopenorclose" ) ) { PrimaryKey user_id = getUserId( req ); if ( user_id == null ) { out.println( "User wasn't specified
" ); return; } LogBookPage page = lb_session.getPageForUser( user_id ); if ( page==null ) req.setSwitchedOff( true ); else req.setSwitchedOff( !lb_session.canOpenOrClose( page.getLogBookPageId() ) ); return; } if ( command.equalsIgnoreCase( "confirmopenlog" ) || command.equalsIgnoreCase( "confirmcloselog" ) ) { PrimaryKey user_id = getUserId( req ); if ( user_id == null ) { out.println( "User wasn't specified
" ); return; } LogBookPage page = lb_session.getPageForUser( user_id ); if ( command.equalsIgnoreCase( "confirmopenlog" ) ) { lb_session.setPageClosed( page.getLogBookPageId(), false ); out.println( "Log Opened.
" ); } else { lb_session.setPageClosed( page.getLogBookPageId(), true ); out.println( "Log Closed.
" ); } return; } if ( command.equalsIgnoreCase( "logpagemenu" ) ) { logPageMenu( req, out, lb_session ); return; } if ( command.equalsIgnoreCase( "logbookpageproperty" ) ) { logBookPageProperty( req, out, lb_session, insertname ); return; } if ( command.equalsIgnoreCase( "fileparagraph" ) ) { if ( out!=null ) { String mode = req.getInsertAttribute( "mode", "link" ); boolean hide_deleted = req.getInsertAttribute( "hidedeleted", "yes" ).equalsIgnoreCase( "yes" ); String linked_url = null; if ( mode.equals( "option" ) ) { PrimaryKey entry_id = getEntryId( req ); LogBookEntry entry = null; if ( null != entry_id ) entry = lb_session.getEntry( entry_id ); if ( null != entry ) linked_url = entry.getLinkedUrl(); } fileparagraph( req, out, null, hide_deleted, mode, linked_url ); } return; } if ( command.equalsIgnoreCase( "uploadtolog" ) ) { if ( null != out ) uploadToLog( req, out ); return; } if ( command.equalsIgnoreCase( "maybeamendpeers" ) ) { if ( null != out ) { boolean amend = (null != req.getParameter( "mode" ) ); if ( amend ) { boolean shouldAdd = req.getParameter( "mode" ).equalsIgnoreCase( "add" ); String user_id = req.getParameter( "userid" ); if ( null != user_id && user_id.length() > 0 ) { amendpeers( req, out, lb_session, shouldAdd, user_id ); } } } return; } if ( command.equalsIgnoreCase( "peers" ) ) { if ( null != out ) { boolean possible = req.getInsertAttribute( "mode", "existing" ).equalsIgnoreCase( "possible" ); peers( req, out, lb_session, possible ); } return; } } catch ( BuildingServerException bsex ) { out.println( bsex.toString() ); return; } super.insert( req, out, command, insertname ); } /** * Private method called from insert() inserts an HTML form field * corresponding to a property of the LogBook with the current value * set as the default value. Used to build a form to modify the logbook * that has the correct current values in it. If the name parameter is * user_closable this produces a check box tag which is checked or unchecked * depending on the current setting of the user_closable field in the * LogBook that was accessed. * * @param req The Request object the defines the page request. * @param out An output writer to send the HTML to. * @param lb_session The user's session with the LogBook. * @param name The name of the field to output. * @exception java.io.IOException * @exception org.bodington.server.BuildingServerException */ private void logBookField( Request req, PrintWriter out, LogBookSession lb_session, String name ) throws IOException, BuildingServerException { if ( name.equalsIgnoreCase( "user_closable" ) ) { out.print( "" ); return; } // current version of log book doesn't have any other fields return; } /** * Private method called from insert() inserts an HTML form field * corresponding to a property of the LogBook with the current value * set as the default value. Used to build a form to modify the logbook * that has the correct current values in it. If the name parameter is * user_closable this produces a check box tag which is checked or unchecked * depending on the current setting of the user_closable field in the * LogBook that was accessed. * * @param req The Request object the defines the page request. * @param out An output writer to send the HTML to. * @param lb_session The user's session with the LogBook. * @param name The name of the field to output. * @exception java.io.IOException * @exception org.bodington.server.BuildingServerException */ private void logBookSectionField( Request req, PrintWriter out, LogBookSession lb_session, String name ) throws IOException, BuildingServerException { // The section id is in the web address requested PrimaryKey section_id = getSectionOrQuestionId( req ); if ( section_id == null ) { out.println( "Section wasn't specified
" ); return; } Hashtable table = lb_session.getSectionAndQuestionTable(); if ( table == null ) { out.println( "No sections in logbook.
" ); return; } LogBookSection section = (LogBookSection)table.get( section_id ); if ( section == null ) { out.println( "Section not in logbook.
" ); return; } if ( name.equalsIgnoreCase( "ordinal" ) ) { out.println( "" ); return; } // span is used to help make it possible to use a style sheet to // select the font and define the size of the textarea in older // browsers. if ( name.equalsIgnoreCase( "title" ) ) { out.print( "" ); out.print( "" ); return; } if ( name.equalsIgnoreCase( "introduction" ) ) { out.print( "" ); out.print( "" ); return; } // current version of log book doesn't have any other fields return; } /** * Private method called from insert() inserts an HTML form field * corresponding to a property of the LogBook with the current value * set as the default value. Used to build a form to modify the logbook * that has the correct current values in it. If the name parameter is * user_closable this produces a check box tag which is checked or unchecked * depending on the current setting of the user_closable field in the * LogBook that was accessed. * * @param req The Request object the defines the page request. * @param out An output writer to send the HTML to. * @param lb_session The user's session with the LogBook. * @param name The name of the field to output. * @exception java.io.IOException * @exception org.bodington.server.BuildingServerException */ private void logBookQuestionField( Request req, PrintWriter out, LogBookSession lb_session, String name ) throws IOException, BuildingServerException { // The section id is in the web address requested PrimaryKey question_id = getSectionOrQuestionId( req ); if ( question_id == null ) { out.println( "Question wasn't specified
" ); return; } Hashtable table = lb_session.getSectionAndQuestionTable(); if ( table == null ) { out.println( "No questions in logbook.
" ); return; } LogBookQuestion question = (LogBookQuestion)table.get( question_id ); if ( question == null ) { out.println( "Question not in logbook.
" ); return; } if ( name.equalsIgnoreCase( "ordinal" ) ) { out.println( "" ); return; } // span is used to help make it possible to use a style sheet to // select the font and define the size of the textarea in older // browsers. if ( name.equalsIgnoreCase( "title" ) ) { out.print( "" ); out.print( "" ); return; } if ( name.equalsIgnoreCase( "question" ) ) { out.print( "" ); out.print( "" ); return; } if ( name.equalsIgnoreCase( "help" ) ) { out.print( "" ); out.print( "" ); return; } // current version of log book doesn't have any other fields return; } /** * Private method called from insert() outputs a given property of the * section as plain text. * * @param req The Request object the defines the page request. * @param out An output writer to send the HTML to. * @param lb_session The user's session with the LogBook. * @param name The name of the property to output. * @exception java.io.IOException * @exception org.bodington.server.BuildingServerException */ private void logBookSectionProperty( Request req, PrintWriter out, LogBookSession lb_session, String name ) throws IOException, BuildingServerException { // The section id is in the web address requested PrimaryKey section_id = getSectionOrQuestionId( req ); if ( section_id == null ) { out.println( "Section wasn't specified
" ); return; } Hashtable table = lb_session.getSectionAndQuestionTable(); if ( table == null ) { out.println( "No sections in logbook." ); return; } LogBookSection section = (LogBookSection)table.get( section_id ); if ( section == null ) { out.println( "Section not in logbook." ); return; } if ( name.equalsIgnoreCase( "ordinal" ) ) { out.print( section.getOrdinal() ); return; } if ( name.equalsIgnoreCase( "title" ) ) { out.print( section.getTitle() ); return; } if ( name.equalsIgnoreCase( "introduction" ) ) { out.print( section.getIntroduction() ); return; } return; } /** * Private method called from insert() inserts plain text * corresponding to a property of the LogBookQuestion * * @param req The Request object the defines the page request. * @param out An output writer to send the HTML to. * @param lb_session The user's session with the LogBook. * @param name The name of the field to output. * @exception java.io.IOException * @exception org.bodington.server.BuildingServerException */ private void logBookQuestionProperty( Request req, PrintWriter out, LogBookSession lb_session, String name ) throws IOException, BuildingServerException { // The section id is in the web address requested PrimaryKey question_id = getSectionOrQuestionId( req ); if ( question_id == null ) { out.println( "Question wasn't specified
" ); return; } Hashtable table = lb_session.getSectionAndQuestionTable(); if ( table == null ) { out.println( "No questions in logbook." ); return; } LogBookQuestion question = (LogBookQuestion)table.get( question_id ); if ( question == null ) { out.println( "Question not in logbook." ); return; } if ( name.equalsIgnoreCase( "ordinal" ) ) { out.print( question.getOrdinal() ); return; } // span is used to help make it possible to use a style sheet to // select the font and define the size of the textarea in older // browsers. if ( name.equalsIgnoreCase( "title" ) ) { out.print( question.getTitle() ); return; } if ( name.equalsIgnoreCase( "question" ) ) { out.print( question.getQuestion() ); return; } if ( name.equalsIgnoreCase( "help" ) ) { out.print( question.getHelp() ); return; } // current version of log book doesn't have any other fields return; } /** * Private method called from insert() inserts plain text * corresponding to a property of the LogBookPage referenced by user_id * * @param req The Request object the defines the page request. * @param out An output writer to send the HTML to. * @param lb_session The user's session with the LogBook. * @param name The name of the field to output. * @exception java.io.IOException * @exception org.bodington.server.BuildingServerException */ private void logBookPageProperty( Request req, PrintWriter out, LogBookSession lb_session, String name ) throws IOException, BuildingServerException { // The section id is in the web address requested PrimaryKey user_id = getUserId( req ); if ( user_id == null ) { out.println( "User wasn't specified
" ); return; } // this isn't a real property of the page but of the user whether // they have a page yet or not if ( name.equalsIgnoreCase( "name" ) ) { out.print( lb_session.getUserFullName( user_id ) ); return; } LogBookPage page = lb_session.getPageForUser( user_id ); if ( page==null ) return; if ( name.equalsIgnoreCase( "when_first" ) ) { if ( page.getWhenFirst() == null ) out.println( "~" ); else out.print( date_format.format( page.getWhenFirst() ) ); return; } if ( name.equalsIgnoreCase( "when_last" ) ) { if ( page.getWhenLast() == null ) out.println( "~" ); else { out.print( date_format.format( page.getWhenLast() ) ); //PrimaryKey user_last_id = page.getUserLastId(); //if ( null != user_last_id ) //out.print( " by " + lb_session.getUserFullName( user_last_id ) ); } return; } if ( name.equalsIgnoreCase( "when_user_first" ) ) { if ( page.getWhenUserFirst() == null ) out.println( "~" ); else out.print( date_format.format( page.getWhenUserFirst() ) ); return; } if ( name.equalsIgnoreCase( "when_user_last" ) ) { if ( page.getWhenUserLast() == null ) out.println( "~" ); else out.print( date_format.format( page.getWhenUserLast() ) ); return; } if ( name.equalsIgnoreCase( "section_first" ) ) { if ( page.getSectionFirst() == null ) out.println( "~" ); else out.print( page.getSectionFirst() ); return; } if ( name.equalsIgnoreCase( "section_last" ) ) { if ( page.getSectionLast() == null ) out.println( "~" ); else out.print( page.getSectionLast() ); return; } if ( name.equalsIgnoreCase( "section_user_first" ) ) { if ( page.getSectionUserFirst() == null ) out.println( "~" ); else out.print( page.getSectionUserFirst() ); return; } if ( name.equalsIgnoreCase( "section_user_last" ) ) { if ( page.getSectionUserLast() == null ) out.println( "~" ); else out.print( page.getSectionUserLast() ); return; } if ( name.equalsIgnoreCase( "question_first" ) ) { if ( page.getQuestionFirst() == null ) out.println( "~" ); else out.print( page.getQuestionFirst() ); return; } if ( name.equalsIgnoreCase( "question_last" ) ) { if ( page.getQuestionLast() == null ) out.println( "~" ); else out.print( page.getQuestionLast() ); return; } if ( name.equalsIgnoreCase( "question_user_first" ) ) { if ( page.getQuestionUserFirst() == null ) out.println( "~" ); else out.print( page.getQuestionUserFirst() ); return; } if ( name.equalsIgnoreCase( "question_user_last" ) ) { if ( page.getQuestionUserLast() == null ) out.println( "~" ); else out.print( page.getQuestionUserLast() ); return; } return; } /** * Takes form input and modifies the properties of the LogBook accordingly * by making calls to the LogBookSession. * * @param req The page request including form input paramters. * @param out The Writer to send a confirmation message to. * @param lb_session The user's session with the logbook. * @exception java.io.IOException * @exception org.bodington.server.BuildingServerException */ private void logBookModify( Request req, PrintWriter out, LogBookSession lb_session ) throws IOException, BuildingServerException { String user_closable = req.getParameter( "user_closable" ); lb_session.setUserClosable( user_closable!=null && user_closable.length()>0 ); out.println( "The requested changes were stored.
" ); } /** * Outputs the titles of the sections and the questions of the log book in * specified format. * * @param req The page request including form input paramters. * @param out The Writer to send a confirmation message to. * @param lb_session The user's session with the logbook. * @param format Selector for the output format to use. * @exception java.io.IOException * @exception org.bodington.server.BuildingServerException */ private void logBookMenu( Request req, PrintWriter out, LogBookSession lb_session, String format ) throws IOException, BuildingServerException { int i, j; String s_page, q_page, target; PrimaryKey user_id=null; boolean new_link, collate_link; if ( FORMAT_EDIT.equalsIgnoreCase( format ) ) { s_page = "bs_template_editsection.html"; q_page = "bs_template_editquestion.html"; target = "editcontent"; new_link = true; collate_link = false; } else if ( FORMAT_CROSSPOST.equalsIgnoreCase( format ) ) { s_page = "bs_template_section.html"; q_page = "bs_template_crosspostquestion.html"; target = "content"; new_link = false; collate_link = false; } else if ( FORMAT_PERSONAL.equalsIgnoreCase( format ) ) { s_page = "bs_template_section.html"; q_page = "bs_template_question.html"; target = "content"; user_id = getUserId( req ); if ( user_id == null ) out.println( "Didn't specify which user's log to view." ); new_link = false; collate_link = true; } else { out.println( "Unknown menu format requested." ); return; } LogBookSection[] sections = lb_session.getSectionsInOrder(); LogBookQuestion[] questions; if ( collate_link ) { // link to collation form out.print( "" ); if ( user_id!=null ) { LogBookPage page = lb_session.getPageForUser( user_id ); if ( page!=null && lb_session.canOpenOrClose( page.getLogBookPageId() ) ) { out.print( "" ); } } } // putting the menu in a 'div' element means we can change the // style of the heading elements independantly of other parts of // the Bodington system by adding lines to the style sheet. out.println( "" ); // Questions similar but are a lower level heading questions = lb_session.getQuestionsInOrder( sections[i].getLogBookSectionId() ); for ( j=0; jA new section was added.
" ); } /** * Immediately creates a new question at the end of the specified section * by making calls to the LogBookSession. * * @param req The page request. * @param out The Writer to send a confirmation message to. * @param lb_session The user's session with the logbook. * @exception java.io.IOException * @exception org.bodington.server.BuildingServerException */ private void newQuestion( Request req, PrintWriter out, LogBookSession lb_session ) throws IOException, BuildingServerException { // The section id is in the web address requested PrimaryKey section_id = getSectionOrQuestionId( req ); if ( section_id == null ) { out.println( "Section wasn't specified
" ); return; } try { lb_session.createQuestion( section_id ); } catch ( BuildingServerException bsex ) { logException( out, "LogBookFacility", "newQuestion", "A technical problem occured tring to create a new question.", bsex ); return; } out.println( "A new question was added.
" ); } /** * Deletes a specified section. * * @param req The page request. * @param out The Writer to send a confirmation message to. * @param lb_session The user's session with the logbook. * @exception java.io.IOException * @exception org.bodington.server.BuildingServerException */ private void deleteSection( Request req, PrintWriter out, LogBookSession lb_session ) throws IOException, BuildingServerException { // The section id is in the web address requested PrimaryKey section_id = getSectionOrQuestionId( req ); if ( section_id == null ) { out.println( "Section wasn't specified
" ); return; } String param=req.getParameter( "confirm" ); if ( param==null ) param=""; String notparam=req.getParameter( "notconfirm" ); if ( notparam==null ) notparam=""; if ( param.length()<1 || notparam.length()>0 ) { out.println( "The section was deleted.
" ); } /** * Deletes a specified question. * * @param req The page request. * @param out The Writer to send a confirmation message to. * @param lb_session The user's session with the logbook. * @exception java.io.IOException * @exception org.bodington.server.BuildingServerException */ private void deleteQuestion( Request req, PrintWriter out, LogBookSession lb_session ) throws IOException, BuildingServerException { // The question id is in the web address requested PrimaryKey question_id = getSectionOrQuestionId( req ); if ( question_id == null ) { out.println( "Question wasn't specified
" ); return; } String param=req.getParameter( "confirm" ); if ( param==null ) param=""; String notparam=req.getParameter( "notconfirm" ); if ( notparam==null ) notparam=""; if ( param.length()<1 || notparam.length()>0 ) { out.println( "The question was deleted.
" ); } /** * Edits a specified section by taking input from an HTML form, validating it * and then calling a method in the session object. Confirmation or an error * message is given. * * @param req The page request. * @param out The Writer to send a confirmation message to. * @param lb_session The user's session with the logbook. * @exception java.io.IOException * @exception org.bodington.server.BuildingServerException */ private void editSection( Request req, PrintWriter out, LogBookSession lb_session ) throws IOException, BuildingServerException { // The section id is in the web address requested as if it were a directory // of the log book PrimaryKey section_id = getSectionOrQuestionId( req ); if ( section_id == null ) { out.println( "Section wasn't specified
" ); return; } String s_ordinal=req.getParameter( "ordinal" ); int ordinal; try { ordinal = Integer.parseInt( s_ordinal ); } catch ( NumberFormatException nfex ) { out.println( "An invalid integer number was given in the ordinal field.
" ); return; } String title=req.getParameter( "title" ); String introduction=req.getParameter( "introduction" ); try { lb_session.changeSection( section_id, ordinal, title, introduction ); } catch ( BuildingServerException bsex ) { logException( out, "LogBookFacility", "editSection", "A technical problem occured tring to save an edited section.", bsex ); return; } out.println( "The section was updated.
" ); } /** * Edits a specified question by taking input from an HTML form, validating it * and then calling a method in the session object. Confirmation or an error * message is given. * * @param req The page request. * @param out The Writer to send a confirmation message to. * @param lb_session The user's session with the logbook. * @exception java.io.IOException * @exception org.bodington.server.BuildingServerException */ private void editQuestion( Request req, PrintWriter out, LogBookSession lb_session ) throws IOException, BuildingServerException { // The question id is in the web address requested as if it were a directory // of the log book PrimaryKey question_id = getSectionOrQuestionId( req ); if ( question_id == null ) { out.println( "Question wasn't specified
" ); return; } String s_ordinal=req.getParameter( "ordinal" ); int ordinal; try { ordinal = Integer.parseInt( s_ordinal ); } catch ( NumberFormatException nfex ) { out.println( "An invalid integer number was given in the ordinal field.
" ); return; } String title=req.getParameter( "title" ); String question=req.getParameter( "question" ); String help=req.getParameter( "help" ); try { lb_session.changeQuestion( question_id, ordinal, title, question, help ); } catch ( BuildingServerException bsex ) { logException( out, "LogBookFacility", "editQuestion", "A technical problem occured tring to save an edited question.", bsex ); return; } out.println( "The question was updated.
" ); } /** * Outputs the poster name and datestamps of a set of entries * * @param req The page request including form input paramters. * @param out The Writer to send a confirmation message to. * @param lb_session The user's session with the logbook. * @exception java.io.IOException * @exception org.bodington.server.BuildingServerException */ private void logEntryMenu( Request req, PrintWriter out, LogBookSession lb_session ) throws IOException, BuildingServerException, ServletException { int i, j; PrimaryKey user_id = getUserId( req ); PrimaryKey question_id = getSectionOrQuestionId( req ); if ( user_id == null ) { out.println( "Unable to determine whose log entries to display.
" ); return; } if ( question_id == null ) { out.println( "Unable to determine which question to search for log entries.
" ); return; } boolean post_permitted = req.getResource().checkPermission( Permission.POST ); LogBookPage page = lb_session.getPageForUser( user_id ); LogBookEntry[] entries = lb_session.getEntriesInOrder( question_id, user_id ); out.println( "Didn't specify which user's log to view.
" ); return; } LogBookSection[] sections = lb_session.getSectionsInOrder(); LogBookQuestion[] questions; out.println( "Unable to determine who's log entries to display.
" ); return; } if ( question_id == null ) { out.println( "Unable to determine which question to search for log entries.
" ); return; } String op = req.getParameter( "operation" ); if ( op==null || op.trim().length() == 0 ) return; if ( op.equalsIgnoreCase( "entryselection" ) ) { String param; LogBookEntry[] entries = lb_session.getEntriesInOrder( question_id, user_id ); for ( i=0; iSelection changes saved.
" ); } } /** * Outputs the text of an entry * * @param req The page request. * @param out The Writer to send the text to. * @param lb_session The user's session with the logbook. * @exception java.io.IOException * @exception org.bodington.server.BuildingServerException */ private void logBookEntry( Request req, PrintWriter out, LogBookSession lb_session ) throws IOException, BuildingServerException { int i, j; PrimaryKey entry_id = getEntryId( req ); LogBookEntry entry = null; if ( entry_id!=null ) entry = lb_session.getEntry( entry_id ); if ( entry == null ) { out.println( "Unable to determine which entry to display.
" ); return; } String format = req.getInsertAttribute( "format", "display" ); if ( "edit".equalsIgnoreCase( format ) ) out.println( entry.getEntry() ); else out.println( formatEntryText( entry, false, true, Integer.MAX_VALUE ) ); } /* private String entryOpening( LogBookEntry entry ) throws BuildingServerException { String text = entry.getEntry(); if ( text.length() < 500 ) return text; int i; for ( i=499; i>200; i++ ) if ( Character.isWhitespace( text.charAt( i ) ) ) break; StringBuffer shortened = new StringBuffer(); shortened.append( text.substring( 0, i ) ); shortened.append( "... There is more text" ); return shortened.toString(); } */ /** * Reads uploaded file and parses out imported questions. * * @param req The page request including form input paramters. * @param out The Writer to send a confirmation message to. * @param lb_session The user's session with the logbook. * @exception java.io.IOException * @exception org.bodington.server.BuildingServerException */ private void parseImportQuestions( Request req, PrintWriter out, LogBookSession lb_session ) throws IOException, BuildingServerException { // find the file that was uploaded to temporary space... String file_name = req.getParameter( "file" ); File file = new File( file_name ); if ( file.length() > (10L*1024L*1024L) ) { out.println( "The uploaded file was too big to process.
" ); return; } // input data is parsed and an HTML form is produced for // checking and confirmation. THe form is put in a temp // file initialy. File temp_file = BuildingContext.createTempFile( "tmplogbookform", ".tmp" ); BufferedWriter form_html=null; try { form_html = new BufferedWriter( new OutputStreamWriter( new FileOutputStream(temp_file), "utf-8" ) ); form_html.write( "" ); form_html.newLine(); form_html.close(); completed=true; } catch ( IOException ioex ) { out.println( "Input error at line " + i + ". ( " + ioex.getMessage() + ")
" ); return; } finally { if ( temp_file!=null ) { try { form_html.close(); } catch ( Exception ex ) { } if ( !completed ) temp_file.delete(); } } BufferedReader form_input=null; try { form_input= new BufferedReader( new InputStreamReader( new FileInputStream( temp_file ), "utf-8" ) ); int c; out.println( "Review the following and confirm if you which to go ahead and import.
" ); while ( (c=form_input.read()) >= 0 ) out.print( (char)c ); } finally { form_input.close(); temp_file.delete(); } } /** * Reads form input and creates new sections and questions. * * @param req The page request including form input paramters. * @param out The Writer to send a confirmation message to. * @param lb_session The user's session with the logbook. * @exception java.io.IOException * @exception org.bodington.server.BuildingServerException */ private void importQuestions( Request req, PrintWriter out, LogBookSession lb_session ) throws IOException, BuildingServerException { int i; String type, title, intro, help; String text; LogBookPage page; // one pass for validation for ( i=1; true; i++ ) { type = req.getParameter( "type_" + i ); if ( type == null || type.length() == 0 ) break; if ( !type.equals( "section" ) && !type.equals( "question" ) ) { out.println( "Invalid form input.
" ); return; } title = req.getParameter( "title_" + i ); intro = req.getParameter( "intro_" + i ); if ( title == null || title.length() == 0 || intro == null || intro.length() == 0 ) { out.println( "Every section and question must have a title and introductory text.
" ); return; } if ( type.equals( "question" ) ) { help = req.getParameter( "help_" + i ); if ( help==null || help.length() == 0 ) { out.println( "Every question must have help text.
" ); return; } } } if ( i==1 ) { out.println( "No sections or questions to add.
" ); return; } // second pass for processing LogBookSection section=null; LogBookQuestion question; for ( i=1; true; i++ ) { type = req.getParameter( "type_" + i ); if ( type == null || type.length() == 0 ) break; title = req.getParameter( "title_" + i ); intro = req.getParameter( "intro_" + i ); if ( type.equals( "question" ) ) help = req.getParameter( "help_" + i ); else help=null; if ( type.equals( "section" ) ) { section=lb_session.createSection(); lb_session.changeSection( section.getLogBookSectionId(), section.getOrdinal(), title, intro ); } else { question=lb_session.createQuestion( section.getLogBookSectionId() ); lb_session.changeQuestion( question.getLogBookQuestionId(), question.getOrdinal(), title, intro, help ); } } out.print( "Import completed.
" ); } /** * Reads form input and makes entries on multiple user's logs. * * @param req The page request including form input paramters. * @param out The Writer to send a confirmation message to. * @param lb_session The user's session with the logbook. * @exception java.io.IOException * @exception org.bodington.server.BuildingServerException */ private void parseCrossPostEntries( Request req, PrintWriter out, LogBookSession lb_session ) throws IOException, BuildingServerException { String type = req.getInsertAttribute( "type", "view" ); if ( "file".equalsIgnoreCase( type ) ) { parseCrossPostEntriesFromFile( req, out, lb_session ); return; } String entry_text = req.getParameter( "entry" ); boolean type_page = "page".equalsIgnoreCase( type ); Vector user_ids; if ( type_page ) user_ids = lb_session.getPageUserIds(); else user_ids = lb_session.getViewUserIds(); out.println( "" ); } private void parseCrossPostEntriesFromFile( Request req, PrintWriter out, LogBookSession lb_session ) throws IOException, BuildingServerException { // find the file that was uploaded to temporary space... String file_name = req.getParameter( "file" ); File file = new File( file_name ); if ( file.length() > (10L*1024L*1024L) ) { out.println( "The uploaded file was too big to process.
" ); return; } // input data is parsed and an HTML form is produced for // checking and confirmation. THe form is put in a temp // file initialy. File temp_file = BuildingContext.createTempFile( "tmplogbookform", ".tmp" ); BufferedWriter form_html=null; try { form_html = new BufferedWriter( new OutputStreamWriter( new FileOutputStream(temp_file), "utf-8" ) ); form_html.write( "" ); form_html.newLine(); form_html.close(); completed=true; } catch ( IOException ioex ) { out.println( "Input error at line " + i + ". ( " + ioex.getMessage() + ")
" ); return; } catch ( NumberFormatException nfex ) { out.println( "Invalid numeric data at line " + i + "
" ); return; } finally { if ( temp_file!=null ) { try { form_html.close(); } catch ( Exception ex ) { } if ( !completed ) temp_file.delete(); } } BufferedReader form_input=null; try { form_input= new BufferedReader( new InputStreamReader( new FileInputStream( temp_file ), "utf-8" ) ); int c; out.println( "Review the following set of new entries and confirm posting.
" ); while ( (c=form_input.read()) >= 0 ) out.print( (char)c ); } finally { form_input.close(); temp_file.delete(); } } /** * Reads form input and makes a new entry. * * @param req The page request including form input paramters. * @param out The Writer to send a confirmation message to. * @param lb_session The user's session with the logbook. * @exception java.io.IOException * @exception org.bodington.server.BuildingServerException */ private void newCrossPostEntries( Request req, PrintWriter out, LogBookSession lb_session ) throws IOException, BuildingServerException { PrimaryKey question_id = getSectionOrQuestionId( req ) ; if ( question_id == null ) { out.println( "Unable to determine which question to search for log entries.
" ); return; } Enumeration enumeration = req.getParameterNames(); Vector user_ids = new Vector(); String pname, str_id, name_user, check_pname, check; PrimaryKey user_id; String text; LogBookPage page; while ( enumeration.hasMoreElements() ) { pname = (String)enumeration.nextElement(); if ( !pname.startsWith( "entry_user_" ) ) continue; str_id = pname.substring( "entry_user_".length() ); try { user_id = new PrimaryKey( Integer.parseInt( str_id ) ); } catch ( NumberFormatException nfex ) { out.println( "Invalid form input.
" ); return; } name_user = lb_session.getUserFullName( user_id ); if ( name_user == null ) { out.println( "An unknown user was given in the form data.
" ); return; } // skip entries where the checkbox wasn't selected check_pname = "include_user_" + user_id.toString(); check = req.getParameter( check_pname ); if ( check==null || check.trim().length()==0 ) continue; text = req.getParameter( pname ); if ( text!=null ) text = text.trim(); if ( text == null || text.length() == 0 ) { out.println( "There was no text in one of the form fields." ); return; } user_ids.addElement( user_id ); } for ( int i=0; iEntry made in the log of " ); out.print( lb_session.getUserFullName( user_id ) ); out.print( ".
" ); } } out.print( "All posting now completed.
" ); } /** * Reads form input and makes a new entry. * * @param req The page request including form input paramters. * @param out The Writer to send a confirmation message to. * @param lb_session The user's session with the logbook. * @exception java.io.IOException * @exception org.bodington.server.BuildingServerException */ private void newEntry( Request req, PrintWriter out, LogBookSession lb_session ) throws IOException, BuildingServerException { boolean d; boolean p; PrimaryKey user_id = getUserId( req ); PrimaryKey question_id = getSectionOrQuestionId( req ) ; if ( user_id == null ) { out.println( "Unable to determine whose log entries to display.
" ); return; } if ( question_id == null ) { out.println( "Unable to determine which question to search for log entries.
" ); return; } String text = req.getParameter( "entry" ); String entrytype = req.getParameter( "entrytype" ); if ( entrytype==null || entrytype.length()==0 ) entrytype = "public"; String linked_url = req.getParameter( "linkedurl" ); if ( "".equals( linked_url ) ) linked_url = null; if ( text!=null ) text = text.trim(); if ( text == null || text.length() == 0 ) { out.println( "There was no text in the form so no entry has been made." ); return; } d = entrytype.equals( "draft" ); p = entrytype.equals( "private" ); lb_session.postEntry( question_id, user_id, text, d, p, linked_url ); out.println( "Entry made.
" ); } /** * Edits content and/or flags of an entry. * * @param req The page request. * @param out The Writer to send the text to. * @param lb_session The user's session with the logbook. * @exception java.io.IOException * @exception org.bodington.server.BuildingServerException */ private void editEntry( Request req, PrintWriter out, LogBookSession lb_session ) throws IOException, BuildingServerException { boolean d; boolean p; PrimaryKey entry_id = getEntryId( req ); LogBookEntry entry = null; if ( entry_id!=null ) entry = lb_session.getEntry( entry_id ); if ( entry == null ) { out.println( "Unable to determine which entry to display.
" ); return; } String text = req.getParameter( "entry" ); String entrytype = req.getParameter( "entrytype" ); String linked_url = req.getParameter( "linkedurl" ); if ( "".equals( linked_url ) ) linked_url = null; if ( text!=null ) text = text.trim(); if ( text == null || text.length() == 0 ) { out.println( "There was no text in the form so no edits have been made." ); return; } d = entrytype.equals( "draft" ); p = entrytype.equals( "private" ); lb_session.editEntry( entry.getLogBookEntryId(), text, d, p, linked_url ); out.println( "Entry saved.
" ); } /** * Outputs a name with a link to its log book page. * * @param out The Writer to send a confirmation message to. * @param lb_session The user's session with the logbook. * @param event_table A table of logbook events filtered down to the most recent READ event where current user was the reader for each log page * @param page The page for which output is to be generated * @exception java.io.IOException * @exception org.bodington.server.BuildingServerException */ private void logPageMenuEntry( PrintWriter out, LogBookSession lb_session, Hashtable event_table, LogBookPage page ) throws IOException, BuildingServerException { int i, j; LogBookEvent event; event = (LogBookEvent)event_table.get( page.getUserId() ); out.print( "" ); out.print( lb_session.getUserFullName( page.getUserId() ) ); out.println( "
" ); if ( event!= null && event.getEventTime()!=null ) { if ( page.getWhenLast() != null ) { if ( page.getWhenLast().after( event.getEventTime() ) ) { out.print( "" ); out.print( "New entries since your last visit." ); //out.print( date_format.format( pages[i].getWhenLast() ) ); out.println( "
" ); } } } else { out.print( "" ); out.print( "Never visited by you." ); //out.print( date_format.format( pages[i].getWhenLast() ) ); out.println( "
" ); } out.println( "" );
out.print( "Summary" );
out.print( "
" );
out.print( "" );
out.print( "Go to log" );
out.println( "
" );
if ( use_tt_tags )
buffer.append( "" );
for ( i=0; i< preprocessed.length(); i++ )
{
if ( preprocessed.regionMatches( i, "http:", 0, 5 ) ||
preprocessed.regionMatches( i, "ftp:", 0, 4 ) ||
preprocessed.regionMatches( i, "mailto:", 0, 7 ) )
{
buffer.append( "" );
for ( j=i; j
" ); else buffer.append( "
\n" ); break; default: buffer.append( c ); } } if ( use_tt_tags ) buffer.append( "" ); buffer.append( "
" ); if ( !suppress_link ) { if ( stripped ) { buffer.append( "You can view the full formatted text of this entry.
" ); } else if ( shortened ) { buffer.append( "There is more text.
" ); } } return buffer.toString(); } /** Check whether an uploaded file is present in an entry; if so, try to upload the file into the log entry. * @return a description of the state of the upload. An empty String denotes success. */ private String uploadToLog( Request req, PrintWriter out ) throws IOException { StringBuffer dest_filename=new StringBuffer(); String file, file_name, mime_type; BuildingSession session; PrimaryKey id; UploadedFileSummary summary; file = req.getParameter( "file" ); file_name = req.getParameterFileName( "file" ); if ( file_name == null || file_name.length() == 0 ) { /* No file specified - warn the user. */ return "Please specify a file to upload"; } dest_filename.append( fileParameter( req ) ); if ( dest_filename.length()>0 ) dest_filename.append( "/" ); dest_filename.append(req.getUserId().toString() + "/"); try { session = BuildingSessionManagerImpl.getSession( req.getResource() ); if ( session==null ) throw new BuildingServerException( "Unable to access the destination resource." ); if ( file!=null && file_name!=null ) { if ( file_name.indexOf( '/' )>=0 || file_name.indexOf( '\\' )>=0 ) { return "File names may not contain any slash or backslash characters."; } dest_filename.append( file_name ); mime_type=req.getServletContext().getMimeType( file_name.toLowerCase() ); if ( mime_type==null ) mime_type="application/octet-stream"; summary = session.getUploadedFileSession().transferFile( file, dest_filename.toString(), mime_type ); } } catch ( Exception ex ) { logException( out, "LogBookFacility", "uploadToLog", "A technical problem occured.", ex ); return "A technical problem occured."; } return ""; } /** * Outputs a HTML paragraph of files in the given path. * * @param req The building HTTP request. * @param out The output stream. * @exception java.io.IOException Thrown if there is a problem outputting the HTML. */ protected void fileparagraph( Request req, PrintWriter out, String basepath, boolean hide_deleted, String mode, String linked_url) throws IOException, ServletException { Enumeration enumeration; int i, j, n; StringBuffer address= new StringBuffer(); BuildingSession session; UploadedFileSummary[] summaries; UploadedFileSummary parent; boolean first = true; boolean atLeastOneFile = false; Vector path = new Vector(); if ( basepath==null ) basepath = "/"; if ( !basepath.endsWith( "/" ) ) basepath = basepath + "/"; if ( !basepath.startsWith( "/" ) ) basepath = "/" + basepath; basepath = basepath + req.getUserId().toString() + "/"; try { session = BuildingSessionManagerImpl.getSession(req.getResource()); summaries = session.getUploadedFileSession().getFileAndDescendentSummaries( basepath, hide_deleted ); } catch ( Exception ex ) { out.println( "Technical Problem finding file list Visitor added. Visitor removed.
" + ex );
return;
}
if ( summaries.length == 0 )
{
summaries = new UploadedFileSummary[1];
UploadedFile uploadedFile = new UploadedFile();
uploadedFile.setFlags( UploadedFileSummary.FLAG_FOLDER );
summaries[0] = uploadedFile.getSummary();
}
path.addElement( summaries[0] );
if ( mode.equals( PARAGRAPH_MODE_OPTION ) )
{
out.print( "");
}
for ( i=1; i
" );
out.print( "" );
out.print( "