source/mircoders/module/ModuleContent.java

   1 /*
   2  * Copyright (C) 2001, 2002 The Mir-coders group
   3  *
   4  * This file is part of Mir.
   5  *
   6  * Mir is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * Mir is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with Mir; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  * In addition, as a special exception, The Mir-coders gives permission to link
  21  * the code of this program with  any library licensed under the Apache Software License,
  22  * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library
  23  * (or with modified versions of the above that use the same license as the above),
  24  * and distribute linked combinations including the two.  You must obey the
  25  * GNU General Public License in all respects for all of the code used other than
  26  * the above mentioned libraries.  If you modify this file, you may extend this
  27  * exception to your version of the file, but you are not obligated to do so.
  28  * If you do not wish to do so, delete this exception statement from your version.
  29  */
  30
  31 package mircoders.module;
  32
  33 import mir.log.LoggerWrapper;
  34 import mir.module.AbstractModule;
  35 import mir.storage.StorageObject;
  36 import mir.util.JDBCStringRoutines;
  37 import mircoders.global.*;
  38
  39 /**
  40  *
  41  * <p>Title: ModuleContent</p>
  42  * <p>Description: helper routines to manage articles</p>
  43  * <p>Copyright: Copyright (c) 2003</p>
  44  * <p>Company: </p>
  45  * @author not attributable
  46  * @version 1.0
  47  */
  48
  49 public class ModuleContent extends AbstractModule
  50 {
  51   static LoggerWrapper logger = new LoggerWrapper("Module.Content");
  52
  53   public ModuleContent() {
  54     super();
  55   }
  56
  57   public ModuleContent(StorageObject aStorage) {
  58     storage = aStorage;
  59   }
  60
  61   public void expireArticleLock(String anId, String aUserId) {
  62     if (!MirGlobal.isUserLoggedIn(anId)) {
  63       unlockArticle(anId, aUserId, false);
  64     }
  65   }
  66
  67   /**
  68    * Locks an article. Forced (that is, without checking wether it's already locked)
  69    * if necessary.
  70    *
  71    * @param anId The article number
  72    * @param aUserId The locking user
  73    * @param aForce Should it e forced?
  74    * @return
  75    */
  76   public boolean lockArticle(String anId, String aUserId, boolean aForce) {
  77     try {
  78       String query =
  79           "update content set to_locking_user=" + JDBCStringRoutines.escapeStringLiteral(aUserId) +
  80           "  where id = " + JDBCStringRoutines.escapeStringLiteral(anId);
  81
  82       if (!aForce)
  83         query = query + " and to_locking_user is null";
  84
  85       return storage.executeUpdate(query) > 0;
  86     }
  87     catch (Throwable t) {
  88       return false;
  89     }
  90   }
  91
  92   /**
  93    * Unlocks an article. Forced (that is, without checking wether it's locked by
  94    *     the person that unlocks it) if necessary.
  95    *
  96    * @param anId The article number
  97    * @param aUserId The user that unlocks
  98    * @param aForce Should it e forced?
  99    * @return <code>true</code> if successfull, <code>false</code> if not
 100    */
 101   public boolean unlockArticle(String anId, String aUserId, boolean aForce)  {
 102     try {
 103       String query =
 104           "update content set to_locking_user=null" +
 105           "  where id = " + JDBCStringRoutines.escapeStringLiteral(anId);
 106
 107       if (!aForce)
 108         query = query + " and to_locking_user = "+JDBCStringRoutines.escapeStringLiteral(aUserId);
 109
 110       return storage.executeUpdate(query) > 0;
 111     }
 112     catch (Throwable t) {
 113       return false;
 114     }
 115   }
 116
 117   /**
 118    * Returns the id of the locking user of an article. <code>null</code> otherwise.
 119    *
 120    * @param anId
 121    * @return
 122    */
 123   public String queryArticleLock(String anId)  {
 124     try {
 125       String result = storage.executeFreeSingleValueSql("select to_locking_user from content where id = " + JDBCStringRoutines.escapeStringLiteral(anId));
 126
 127       if (result!=null && !MirGlobal.isUserLoggedIn(result)) {
 128         expireArticleLock(anId, result);
 129         result = null;
 130       }
 131
 132       return result;
 133     }
 134     catch (Throwable t) {
 135       return null;
 136     }
 137   }
 138 }
 139
 140