* $RCSfile: CvFileEJB.java,v $    $Revision: 1.9 $  $Date: 2005/10/13 13:05:05 $ - $Author: mcallist $

*

* The contents of this file are subject to the Open Software License

* Version 2.1 (the "License"); you may not use this file except in

* compliance with the License. You may obtain a copy of the License at

* http://www.centraview.com/opensource/license.html

*

* Software distributed under the License is distributed on an "AS IS"

* basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the

* License for the specific language governing rights and limitations

* under the License.

*

* The Original Code is: CentraView Open Source.

*

* The developer of the Original Code is CentraView.  Portions of the

* Original Code created by CentraView are Copyright (c) 2004 CentraView,

* LLC; All Rights Reserved.  The terms "CentraView" and the CentraView

* logos are trademarks and service marks of CentraView, LLC.

*/

  private static final int DEFAULT_LOCATION = 1;

  private int transactionID = 0;

  protected SessionContext sessionContext;

  private String dataSource = "";

  private static Logger logger = Logger.getLogger(CvFileEJB.class);

  public void setSessionContext(SessionContext sessionContext)

  {

    this.sessionContext = sessionContext;

  }

  public void ejbCreate(){}

  public void ejbRemove(){}

  public void ejbActivate(){}

  public void ejbPassivate(){}

  public FileListElement getParentFolder(int individualId, int folderId, int parentId)

  {

    FileListElement filelistelement = null;

    if (parentId != 0 )

    {

      IntMember intFolderID = new IntMember("ID", folderId, 10, "", 'T', false, 10);

      StringMember strName = new StringMember("Name", "Parent Folder", 10, "/centraview/ViewHandler.do?typeOfContact=entity&rowId=1", 'T', true);

      ModuleFieldRightMatrix mfrmx = CVUtility.getUserModuleRight("File", individualId, false, this.dataSource);

      StringMember strDescription = new StringMember("Description", "The Description", mfrmx.getFieldRight("File", "description"), "", 'T', false);

      StringMember strCreatedBY = new StringMember("CreatedBy", "", 10, "/centraview/ViewHandler.do?typeOfContact=entity&rowId=1", 'T', true);

      StringMember strFileFolder = new StringMember("FileFolder", "FOLDER", 10, "", 'T', false);

      IntMember intIndividualID = new IntMember("IndividualID", individualId, 10, "", 'T', false, 10);

      StringMember strFolderName = new StringMember("FolderName", "Parent Folder", 10, "", 'T', false);

      int parentFolderId = parentId;

      IntMember intParentFolderId = new IntMember("ParentFolderId", parentFolderId, 10, "", 'T', false, 10);  // So we can have the parentFolderId for the file

      filelistelement = new FileListElement(folderId);

      filelistelement.put("FolderID", intFolderID);

      filelistelement.put("Name", strName);

      filelistelement.put("Description", strDescription);

      filelistelement.put("CreatedBy", strCreatedBY);

      filelistelement.put("Created", null);

      filelistelement.put("Updated", null);

      filelistelement.put("FileFolder", strFileFolder);

      filelistelement.put("IndividualID", intIndividualID);

      filelistelement.put("FolderName", strFolderName);

      filelistelement.put("ParentID", intParentFolderId);

    }

    return filelistelement;

  }   // end getParentFolder(int,int,int) method

  public FileList getAllFiles(int individualId, HashMap hashmap)

  {

    Integer intStart = (Integer)hashmap.get("startATparam");

    Integer intEnd = (Integer)hashmap.get("EndAtparam");

    String strSearch = (String)hashmap.get("searchString");

    String strSortMem = (String)hashmap.get("sortmem");

    Character chrSortType = (Character)hashmap.get("sortType");

    String strFileTypeReq = (String)hashmap.get("fileTypeRequest");

    Boolean systemincl = (Boolean)hashmap.get("SystemIncludeFlag");

    Integer intfolderID = (Integer)hashmap.get("curFolderID");

    char charSort = chrSortType.charValue();

    int intStartParam = intStart.intValue();

    int intEndParam = intEnd.intValue();

    int folderID = intfolderID.intValue();

    String strOriginal = strSearch;

    boolean boolIncludeSystem = false;

    if (systemincl != null)

    {

      boolIncludeSystem = systemincl.booleanValue();

    }

    int beginIndex = 0;

    FileList filelist = new FileList();

    filelist.setSortMember(strSortMem);

    Vector vec = new Vector();

    CVDal cvdl = new CVDal(this.dataSource);

    Collection colList = null;

    try

    {

      // this method creates the temporary table "fileaccess", and "folderaccess" that we will do our selects against, in this way

      // we can be sure that the rest of the code uses only records the Individual is allowed to work see.

      // This relies on these TEMPORARY tables sticking around at least throughout the life of this instance of CVDal.

      CVUtility.getAllAccessibleRecords("File", "fileaccess", "cvfile", "FileID", "Owner", "(cvfile.owner=" + individualId + " or cvfile.visibility='PUBLIC')", individualId, cvdl);

      CVUtility.getAllAccessibleRecords("CVFolder", "folderaccess", "cvfolder", "FolderID", "owner", "(cvfolder.owner=" + individualId + " and cvfolder.IsSystem='FALSE') or (cvfolder.visibility='PUBLIC')", individualId, cvdl);

      // We are doing an advanced search, or as with relatedinfo stuff selecting a subset,

      // first create a temporary table  RelatedInfo currently uses this for getting the files related to an Individual.

      if (strSearch != null && strSearch.startsWith("ADVANCE:"))

      {

        strSearch = strSearch.substring(8);

        String str = "CREATE TEMPORARY TABLE filelistSearch " + strSearch;

        cvdl.setSqlQueryToNull();

        cvdl.setSqlQuery(str);

        cvdl.executeUpdate();

        cvdl.setSqlQueryToNull();

        if (strFileTypeReq.equals(FileConstantKeys.ALL)) // FileTypeReq is MY or ALL  so this is if selecting from ALL

        {

          String strQuery = "";

          String sortType = "ASC";

          if (charSort == 'A')

          {

            sortType = "ASC";

          }else{

            sortType = "DESC";

          }

          strQuery =  // This query grabs ALL files

            "select 'FILE' as FileFolder,cvfl.Name as FolderName,indv.individualid as individualid,fil.fileid ID,fil.name Name,fil.description Description,fil.created Created,fil.updated Updated,concat(indv.FirstName,'',indv.LastName) 'Created BY', fld.folderid AS Parent from cvfile fil ,individual indv,cvfilefolder fld,cvfolder cvfl,filelistSearch fSearch, fileaccess fla where indv.individualid=fil.owner and cvfl.folderid=fld.folderid and fld.fileid=fil.fileid and fla.fileid=fil.fileid and fSearch.fileid=fil.fileid and fld.folderid != 6 order by '"

            + strSortMem

            + "' "

            + sortType;

          cvdl.setSqlQuery(strQuery);

          colList = cvdl.executeQuery();

          cvdl.setSqlQueryToNull();

        }else{

          // Selecting MY files.

          String strQuery = "";

          String sortType = "ASC";

          if (charSort == 'A')

          {

            sortType = "ASC";

          }else{

            sortType = "DESC";

          }

          strQuery = // This query gets all files where ownerid of the file = the IndividualId, for some reason this query has some

                     // differences from the ALL query above, these should probably be investigated.

            "select 'FILE' as FileFolder,cvfl.Name as FolderName,indv.individualid as individualid,fil.fileid ID,fil.name Name,fil.description Description,fil.created Created,fil.updated Updated,concat(indv.FirstName,'',indv.LastName) 'Created BY', fld.folderid AS Parent from cvfile fil ,individual indv,cvfilefolder fld,cvfolder cvfl,filelistSearch fSearch  where indv.individualid=fil.owner and fld.fileid=fil.fileid and fil.owner=? and cvfl.folderid=fld.folderid and fSearch.fileid=fil.fileid and fld.folderid != 6 order by '"

            + strSortMem

            + "' "

            + sortType;

          cvdl.setSqlQuery(strQuery);

          cvdl.setInt(1, individualId);

          colList = cvdl.executeQuery();

        }

        cvdl.setSqlQueryToNull();

        cvdl.setSqlQuery("DROP TABLE filelistSearch");  // get rid of the no longer necessary temp table.

        cvdl.executeUpdate();

      }else{

        // There is no search to be done, so just getallfiles

        if (strFileTypeReq.equals(FileConstantKeys.MY) && folderID == -1)  // MY files and for somereason folderID == -1 ?

        {

          // I think this means include SYSTEM files/folders.

          // I think this is hardcoded to never go into this branch.

          // TODO: validate this is a dead branch and cull it.

          cvdl.setSql("file.getuserfiles");

          cvdl.setInt(1, individualId);

          cvdl.setInt(2, individualId);

          colList = cvdl.executeQuery();

        }else if (strFileTypeReq.equals(FileConstantKeys.ALL)){

          String sortType = "ASC";

          if (charSort == 'A')

          {

            sortType = "ASC";

          }else{

            sortType = "DESC";

          }

          cvdl.setDynamicQuery("file.allfilefolderssystem", sortType, strSortMem);

          cvdl.setInt(1, folderID);

          cvdl.setInt(2, folderID);

          colList = cvdl.executeQuery();

        }else if (strFileTypeReq.equals(FileConstantKeys.MY)){

          // So this is just MY files which are NOT in System Folders.

          String sortType = "ASC";

          if (charSort == 'A')

          {

            sortType = "ASC";

          }else{

            sortType = "DESC";

          }

          cvdl.setDynamicQuery("file.myfilefoldersnonsystem", sortType, strSortMem);

          cvdl.setInt(1, folderID);

          cvdl.setInt(2, individualId);

          cvdl.setInt(3, folderID);

          cvdl.setInt(4, individualId);

          colList = cvdl.executeQuery();

        }else if (strFileTypeReq.equals("INDV")){

          // get Individual Files ??? I thought it was MY or ALL.

          // TODO: this appears to be a dead branch.  I can't find references

          // in the code anywhere If you see the printout in code the remove

          // this task, otherwise we should cull the branch eventually

          cvdl.setSql("file.getindividualfiles");

          cvdl.setInt(1, individualId);

          cvdl.setInt(2, individualId);

          colList = cvdl.executeQuery();

        }

      }

      // Okay so we now have our results, clean up the access TEMP tables.

      cvdl.setSqlQueryToNull();

      cvdl.setSqlQuery("drop table folderaccess");

      cvdl.executeUpdate();

      cvdl.setSqlQueryToNull();

      cvdl.setSqlQuery("drop table fileaccess");

      cvdl.executeUpdate();

    }finally{

      cvdl.destroy();

      cvdl = null;

    }

    // Build the DisplayList

    Iterator it = colList.iterator();

    int i = 0;

    if (colList != null)

    {

      ModuleFieldRightMatrix mfrmx = CVUtility.getUserModuleRight("File", individualId, false, dataSource);

      while (it.hasNext())

      {

        i++;

        HashMap hm = (HashMap)it.next();

        int FolderID = ((Long)hm.get("ID")).intValue();

        try

        {

          // Often this code has hardcoded field auth values of 10 which is DELETE or full privileges.

          // FolderID is not a good name here.  It is actually the ID of the file/folder in the Element.

          IntMember intFolderID = new IntMember("ID", FolderID, 10, "", 'T', false, 10);

          StringMember strName = new StringMember("Name", (String)hm.get("Name"), 10, "/centraview/ViewHandler.do?typeOfContact=entity&rowId=1", 'T', true);

          StringMember strDescription = null;

          if ((hm.get("Description") != null))

          {

            // If we have Description create the member, including the field rights.

            strDescription = new StringMember("Description", (String)hm.get("Description"), mfrmx.getFieldRight("File", "description"), "", 'T', false);

          }else{

            strDescription = new StringMember("Description", null, mfrmx.getFieldRight("File", "description"), "", 'T', false);

          }

          StringMember strCreatedBY = new StringMember("CreatedBy", (String)hm.get("Created BY"), 10, "/centraview/ViewHandler.do?typeOfContact=entity&rowId=1", 'T', true);

          StringMember strFileFolder = new StringMember("FileFolder", (String)hm.get("FileFolder"), 10, "", 'T', false);

          IntMember intIndividualID = new IntMember("IndividualID", ((Long)hm.get("individualid")).intValue(), 10, "", 'T', false, 10);

          StringMember strFolderName = null;

          IntMember intParentFolderId = null;

          int parentFolderId = (hm.get("Parent") != null) ? ((Number)hm.get("Parent")).intValue() : 0;

          // Populate the folderName member correctly, if its an advanced search then we alredy have folderName, so just set it directly.

          if (strOriginal != null && strOriginal.startsWith("ADVANCE:"))

          {

            strFolderName = new StringMember("FolderName", (String)hm.get("FolderName"), 10, "", 'T', false);

            intParentFolderId = new IntMember("ParentFolderId", parentFolderId, 10, "", 'T', false, 10);  // So we can have the parentFolderId for the file

          }else if (folderID != -1){

            // If it wasn't advanced search, and we aren't a system folder then get the name from the folderVO, we have the ID.

            // BTW this is very inefficient, because we may do many many more queries and create folderVOs just to get the name, when we could have

            strFolderName = new StringMember("FolderName", (String) ((getFolder(individualId, folderID)).getName()), 10, "", 'T', false);

            intParentFolderId = new IntMember("ParentFolderId", parentFolderId, 10, "", 'T', false, 10);  // So we can have the parentFolderId for the file

            // If folderID and parentFolderId are not equivalent here, then we have some issues.

          }else if (folderID == -1){

            // If it is a System folder (system = TRUE in database)

            strFolderName = new StringMember("FolderName", null, 10, "", 'T', false);

            intParentFolderId = new IntMember("ParentFolderId", parentFolderId, 10, "", 'T', false, 10);

          }

          Timestamp dtCreated = null;

          Timestamp dtUpdated = null;

          DateMember dmCreated = null;

          DateMember dmUpdated = null;

          String timezoneid = "EST";

          if ((hm.get("Created") != null))

          {

            dtCreated = (Timestamp)hm.get("Created");

            dmCreated = new DateMember("Created", dtCreated, 10, "", 'T', false, 1, timezoneid);

          }else{

            dmCreated = new DateMember("Created", null, 10, "", 'T', false, 1, timezoneid);

          }

          if ((hm.get("Updated") != null))

          {

            dtUpdated = (Timestamp)hm.get("Updated");

            dmUpdated = new DateMember("Updated", dtUpdated, 10, "", 'T', false, 1, timezoneid);

          }else{

            dmUpdated = new DateMember("Updated", null, 10, "", 'T', false, 1, timezoneid);

          }

          StringMember title = null;

          if ((hm.get("NameTitle") != null))

          {

            title = new StringMember("NameTitle", (String)hm.get("NameTitle"), 10, "/centraview/ViewHandler.do?typeOfContact=entity&rowId=1", 'T', true);

          }

          FileListElement filelistelement = new FileListElement(FolderID);

          filelistelement.put("FolderID", intFolderID);

          filelistelement.put("Name", strName);

          filelistelement.put("Description", strDescription);

          filelistelement.put("CreatedBy", strCreatedBY);

          filelistelement.put("Created", dmCreated);

          filelistelement.put("Updated", dmUpdated);

          filelistelement.put("FileFolder", strFileFolder);

          filelistelement.put("IndividualID", intIndividualID);

          filelistelement.put("FolderName", strFolderName);

          filelistelement.put("ParentID", intParentFolderId);

          filelistelement.put("NameTitle", title);

          // gah ???

          // What is wrong with using an Integer or a Long as the index.

          StringBuffer stringbuffer = new StringBuffer("00000000000");

          stringbuffer.setLength(11);

          String s3 = (new Integer(i)).toString();

          stringbuffer.replace(stringbuffer.length() - s3.length(), stringbuffer.length(), s3);

          String s4 = stringbuffer.toString();

          filelist.put(s4, filelistelement);

        }catch (Exception e){

          logger.error("[getAllFiles] Exception thrown.", e);

        }

      }   // end while(it.hasNext())

    }   // end if (colList != null)

    if (folderID != -1 && (strSearch == null || strSearch.equals("")))

    {

      Vector rootPath = getFolderRootPath(individualId, folderID);

      filelist.setDirectoryStructure(rootPath);

    }

    filelist.setTotalNoOfRecords(filelist.size());

    filelist.setListType("File");

    filelist.setBeginIndex(beginIndex);

    filelist.setFileTypeRequest(strFileTypeReq);

    filelist.setEndIndex(filelist.size());

    return filelist;

  }   // end getAllFiles(int,HashMap) method

  /**

   * Adds a new folder

   */

  public int addFolder(int individualId, CvFolderVO fdvo) throws CvFileException, AuthorizationFailedException

  {

    if (!CVUtility.isModuleVisible("File", individualId, this.dataSource)) {

      throw new AuthorizationFailedException("File - addFolder");

    }

    int folderID = 0;

    try {

      if (fdvo == null) {

        throw new CvFileException(CvFileException.INVALID_DATA, "Cannot add folder. FolderVo is empty.");

      }

      if (fdvo.getName() == null || fdvo.getName().length() == 0) {

        throw new CvFileException(CvFileException.INVALID_DATA, "Name is Empty");

      }

      if (fdvo.getIsSystem() == null) {

        fdvo.setIsSystem(CvFolderVO.FS_SYSTEM_NO);

      }

      if (fdvo.getVisibility() == null) {

        fdvo.setVisibility(CvFolderVO.FDV_PRIVATE);

      }

      if (fdvo.getOwner() == 0) {

        fdvo.setOwner(individualId);

      }

      // allow attaching to root here. will be used in admin

      if (fdvo.getParent() <= 0) {

        fdvo.setParent(0); // root folder

      } else if (!folderExist(fdvo.getParent())) {

        throw new CvFileException(CvFileException.PARENT_NOT_FOUND, "Parent Not found for new folder: Parent id = " + fdvo.getParent());

      }

      if (fdvo.getLocationId() == 0) {

        fdvo.setLocationId(DEFAULT_LOCATION);

      }

      CVDal cvdl = new CVDal(dataSource);

      try {

        cvdl.setSql("file.insertfolder");

        cvdl.setString(1, fdvo.getName());

        cvdl.setString(2, fdvo.getDescription());

        cvdl.setInt(3, fdvo.getParent());

        cvdl.setInt(4, fdvo.getLocationId());

        cvdl.setInt(5, fdvo.getOwner());

        cvdl.setString(6, fdvo.getIsSystem());

        cvdl.setString(7, fdvo.getVisibility());

        cvdl.setInt(8, individualId);

        cvdl.setInt(9, individualId);

        cvdl.executeUpdate();

        folderID = cvdl.getAutoGeneratedKey();

      } finally {

        cvdl.destroy();

        cvdl = null;

      }

      // call the authorization EJB to set the record public if warranted

      if (fdvo.getVisibility().equals("PUBLIC")) {

        InitialContext ic = CVUtility.getInitialContext();

        AuthorizationLocalHome home = (AuthorizationLocalHome)ic.lookup("local/Authorization");

        AuthorizationLocal remote = home.create();

        remote.setDataSource(dataSource);

        remote.setRecordToPublic("76", folderID);  // 76 is the folder "module" id.

      }

    } catch (Exception e) {

      logger.error("[addFolder] Exception thrown.", e);

      throw new CvFileException(CvFileException.INSERT_FAILED, "Failed in file ejb while adding folder");

    }

    return folderID;

  } // end addFolder() method

  /**

   * checks whether folder exists

   *

   * @param folderId

   * @return

   * @exception CvFileException

   */

  public boolean folderExist(int folderId) throws CvFileException

  {

    CVDal cvdl = new CVDal(dataSource);

    Collection col = null;

    try {

      cvdl.setSql("file.getfolder");

      cvdl.setInt(1, folderId);

      col = cvdl.executeQuery();

    } finally {

      cvdl.destroy();

      cvdl = null;

    }

    if (col == null)

      return false;

    else

      return true;

  }

  /**

   * Get the the home folder based on individualId (owner)

   * @param individualId The UserID (owner) of the folder

   * @return A CvFolderVO object with the necessary details.

   * @exception CvFileException

   */

  public CvFolderVO getHomeFolder(int userID) throws CvFileException, AuthorizationFailedException

  {

    int homeFolderID = getHomeFolderID(userID);

    return this.getFolder(userID, homeFolderID);

  }

  private int getHomeFolderID(int userID) throws CvFileException

  {

    int homeFolderID;

    CVDal cvdl = new CVDal(this.dataSource);

    try

    {

      cvdl.setSql("file.gethomefolder");

      cvdl.setInt(1,userID);

      Collection col = cvdl.executeQuery();

      if (col == null)

      {

        throw new CvFileException(CvFileException.GET_FAILED,"Could not find home folder for owner : " + userID);

      }

      Iterator it = col.iterator();

      HashMap hm = (HashMap)it.next();

      homeFolderID = Integer.parseInt(((String)hm.get("HomeFolderID")));

    }catch(Exception e){

      logger.error("[getHomeFolderID] Exception thrown.  for userId = "+userID, e);

      throw new CvFileException(CvFileException.GET_FAILED,"Could not find home folder for user: " + userID);

    }finally{

      cvdl.destroy();

      cvdl = null;

    }

    return homeFolderID;

  }   // end getHomeFolderID() method

  /**

   * Det the details of the folder

   * @param individualId The UserID (owner) of the folder.