qadevOOo/runner/convwatch/FilenameHelper.java

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: FilenameHelper.java,v $
  10  * $Revision: 1.5.8.1 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 /**
  32  * Helper class to hold a Filename or a FileURL
  33  * Something like File in Java,
  34  * with some more extensions direct to ConvWatch and it's name conventions
  35  *
  36  *
  37  */
  38 package convwatch;
  39
  40 import helper.URLHelper;
  41 import convwatch.FileHelper;
  42 import helper.StringHelper;
  43 import util.utils;
  44
  45 interface Filenamer
  46 {
  47     public String getSuffix();
  48     public String getFileURL();
  49     public String getAbsoluteSystemFilename();
  50     public String getFilename();
  51     public String getSystemPath();
  52 }
  53
  54 // -----------------------------------------------------------------------------
  55
  56 abstract class FilenameHelper_impl implements Filenamer
  57 {
  58     String fs;                                   // file separator like '/'
  59     String m_sPath;
  60     String m_sFilename;
  61     String m_sSuffix;
  62     int    m_nNumber = 0;
  63
  64     public String getNumber()
  65         {
  66             return StringHelper.createValueString(m_nNumber, 4);
  67         }
  68     public void setNumber(int _n)
  69         {
  70             m_nNumber = _n;
  71         }
  72     void initMember()
  73         {
  74             fs = System.getProperty("file.separator");
  75         }
  76
  77         /**
  78          * initialise a FilenameHelper_impl with a complete filename.
  79          * if the filename starts with 'file:///' it is interpret as a file URL
  80          *
  81          */
  82     public FilenameHelper_impl()
  83         {
  84             initMember();
  85         }
  86
  87     public void setCompleteFilename(String _sFilename)
  88         {
  89             if (_sFilename.startsWith("file:///"))
  90             {
  91                 _sFilename = FileHelper.getSystemPathFromFileURL(_sFilename);
  92             }
  93             _sFilename = utils.replaceAll13(_sFilename, "\\\\", "/");
  94
  95             String sPath = checkPath(FileHelper.getPath(_sFilename));
  96             String sFilenameWithSuffix = checkFilename(FileHelper.getBasename(_sFilename));
  97             String sSuffix = splitSuffix(sFilenameWithSuffix);
  98
  99             m_sPath = sPath;
 100             m_sFilename = FileHelper.getNameNoSuffix(sFilenameWithSuffix);
 101             m_sSuffix = sSuffix;
 102         }
 103
 104         /**
 105          * initialise a FilenameHelper_impl with a path a name and a suffix separately
 106          */
 107     public FilenameHelper_impl(String _sPath, String _sName, String _sSuffix)
 108         {
 109             initMember();
 110             _sPath = utils.replaceAll13(_sPath, "\\\\", "/");
 111
 112             String sPath = checkPath(_sPath);
 113             String sFilename = checkFilename(_sName);
 114             String sSuffix = checkSuffix(_sSuffix);
 115
 116             m_sPath = sPath;
 117             m_sFilename = sFilename;
 118             m_sSuffix = sSuffix;
 119         }
 120
 121     /**
 122      * @return the current path as a OOo path URL
 123      */
 124     public String getFileURL()
 125         {
 126             String sSystemPath = createAbsoluteFilename();
 127             String sFileURL = URLHelper.getFileURLFromSystemPath(sSystemPath);
 128             return sFileURL;
 129         }
 130
 131
 132     /**
 133      * @return the current path as a system path
 134      */
 135     public String getAbsoluteSystemFilename()
 136         {
 137             String sSystemFilename = createAbsoluteFilename();
 138             sSystemFilename = utils.replaceAll13(sSystemFilename, "/", fs);
 139             return sSystemFilename;
 140         }
 141
 142     /**
 143      * @return the filename without it's suffix
 144      */
 145     public String getName()
 146     {
 147         return m_sFilename;
 148     }
 149     /**
 150      * set only the filename, maybe it's is only a directory.
 151      */
 152     public void setName(String _sName)
 153         {
 154             m_sFilename = _sName;
 155         }
 156     public void setPath(String _sName)
 157         {
 158             m_sPath = _sName;
 159         }
 160
 161     /**
 162      * @return a created name
 163      */
 164     abstract public String buildName();
 165         // {
 166         //    return getName();
 167         // }
 168
 169     /**
 170      * @return the complete filename with it's suffix
 171      */
 172     public String getFilename()
 173         {
 174             return buildName() + "." + getSuffix();
 175         }
 176
 177      /**
 178       * @return the path as system path
 179       */
 180     public String getSystemPath()
 181     {
 182         String sSystemPath = m_sPath;
 183         sSystemPath = utils.replaceAll13(sSystemPath, "/", fs);
 184         return sSystemPath;
 185     }
 186     /**
 187      * @return true, if current SystemPath is a directory
 188      */
 189     public boolean isDirectory()
 190         {
 191             return FileHelper.isDir(getSystemPath());
 192         }
 193
 194     /**
 195      * @return true, if the file really exist.
 196      */
 197     public boolean exists()
 198         {
 199             return FileHelper.exists(createAbsoluteFilename());
 200         }
 201
 202     /**
 203      * @return the current suffix
 204      */
 205     public String getSuffix()
 206         {
 207             return m_sSuffix;
 208         }
 209     /**
 210      * @return the complete name. Without convert the path separator!
 211      */
 212     String createAbsoluteFilename()
 213         {
 214             return m_sPath + fs + getFilename();
 215         }
 216
 217     /*
 218      * remove follows 'file separators'
 219      */
 220     String checkPath(String _sPath)
 221         {
 222             String sPath;
 223             if (_sPath.endsWith("/") || _sPath.endsWith("\\"))
 224             {
 225                 sPath = _sPath.substring(0, _sPath.length() - 1);
 226             }
 227             else
 228             {
 229                sPath = _sPath;
 230             }
 231             return sPath;
 232         }
 233
 234     String checkFilename(String _sFilename)
 235         {
 236             String sFilename;
 237             if (_sFilename.startsWith("/") || _sFilename.startsWith("\\"))
 238             {
 239                 sFilename = _sFilename.substring(1);
 240             }
 241             else
 242             {
 243                sFilename = _sFilename;
 244             }
 245             return sFilename;
 246         }
 247
 248     String checkSuffix(String _sSuffix)
 249         {
 250             String sSuffix;
 251             if (_sSuffix.startsWith("."))
 252             {
 253                 sSuffix = _sSuffix.substring(1);
 254             }
 255             else
 256             {
 257                 sSuffix = _sSuffix;
 258             }
 259             return sSuffix;
 260         }
 261
 262     String splitSuffix(String _sName)
 263         {
 264             String sSuffix = FileHelper.getSuffix(_sName);
 265             return checkSuffix(sSuffix);
 266         }
 267
 268     public boolean equals(FilenameHelper_impl _aOtherFN)
 269         {
 270             String sPath = createAbsoluteFilename();
 271             String sPathOther = _aOtherFN.createAbsoluteFilename();
 272             if (sPath.equals(sPathOther))
 273             {
 274                 return true;
 275             }
 276             return false;
 277         }
 278
 279 }
 280
 281 /**
 282  * Original filename
 283  */
 284 class OriginalFilename  extends FilenameHelper_impl
 285 {
 286     public String buildName()
 287         {
 288             return getName();
 289         }
 290
 291     public OriginalFilename(){}
 292     public OriginalFilename(String _path, String _filename, String _ext) { super(_path, _filename, _ext);}
 293 }
 294
 295 /**
 296  * Reference from original
 297  */
 298 class OriginalReferenceFilename extends FilenameHelper_impl
 299 {
 300     public String getSuffix()
 301         {
 302             return "prn";
 303         }
 304     public String buildName()
 305         {
 306             return getName();
 307         }
 308     public OriginalReferenceFilename(){}
 309     public OriginalReferenceFilename(String _path, String _filename, String _ext) { super(_path, _filename, _ext);}
 310 }
 311
 312 /**
 313  * picture from reference from original
 314  */
 315 class OriginalReferencePictureFilename extends FilenameHelper_impl
 316 {
 317     public String getSuffix()
 318         {
 319             return "jpg";
 320         }
 321     public String buildName()
 322         {
 323             return getName() + "-" + getNumber() + "-ref";
 324         }
 325     public String getBuildString()
 326         {
 327             return getName() + "-" + "%04d" + "-ref";
 328         }
 329
 330     public OriginalReferencePictureFilename(){}
 331     public OriginalReferencePictureFilename(String _path, String _filename, String _ext) { super(_path, _filename, _ext);}
 332 }
 333
 334 /**
 335  * Reference from OpenOffice.org
 336  */
 337 class CurrentReferenceFilename extends FilenameHelper_impl
 338 {
 339     public String getSuffix()
 340         {
 341             return "ps";
 342         }
 343     public String buildName()
 344         {
 345             return getName();
 346         }
 347
 348     public CurrentReferenceFilename(){}
 349     public CurrentReferenceFilename(String _path, String _filename, String _ext) { super(_path, _filename, _ext);}
 350 }
 351
 352 /**
 353  * picture from reference from OpenOffice.org
 354  */
 355 class CurrentReferencePictureFilename extends FilenameHelper_impl
 356 {
 357     public String getSuffix()
 358         {
 359             return "jpg";
 360         }
 361     public String buildName()
 362         {
 363             return getName() + "-" + getNumber() + "-new-ref";
 364         }
 365     public String getBuildString()
 366         {
 367             return getName() + "-" + "%04d" + "-new-ref";
 368         }
 369
 370     public CurrentReferencePictureFilename(){}
 371     public CurrentReferencePictureFilename(String _path, String _filename, String _ext) { super(_path, _filename, _ext);}
 372 }
 373
 374
 375 public class FilenameHelper
 376 {
 377
 378     public static void main(String[] args)
 379         {
 380             OriginalReferenceFilename d = new OriginalReferenceFilename();
 381             d.setCompleteFilename("c:\\dir1\\dir2\\name.ext");
 382             System.out.println("Suffix: " + d.getSuffix());
 383             System.out.println("Path: " + d.getSystemPath());
 384             System.out.println("Absolute system path filename: " + d.getAbsoluteSystemFilename());
 385             System.out.println("URL: " + d.getFileURL());
 386             System.out.println("Filename: " + d.getFilename());
 387
 388             OriginalReferenceFilename a = new OriginalReferenceFilename("/dir1/dir2/", "name",".ext");
 389             OriginalReferenceFilename a1 = new OriginalReferenceFilename("/dir1/dir2","name.ext","");
 390             OriginalReferenceFilename a2 = new OriginalReferenceFilename("/dir1/dir2","/name.ext","");
 391             OriginalReferenceFilename a3 = new OriginalReferenceFilename("/dir1/dir2","/name",".ext");
 392             OriginalReferenceFilename a4 = new OriginalReferenceFilename("/dir1/dir2","name","ext");
 393
 394
 395             // OriginalReferenceFilename b = new OriginalReferenceFilename("c:/dir1/dir2/name.ext");
 396             // OriginalReferenceFilename c = new OriginalReferenceFilename("file:///dir1/dir2/name.ext");
 397             // OriginalReferenceFilename e = new OriginalReferenceFilename("c:\\dir1\\dir2\\name");
 398             // OriginalReferenceFilename f = new OriginalReferenceFilename("c:\\dir1\\dir2");
 399             // OriginalReferenceFilename g = new OriginalReferenceFilename("c:\\dir1\\dir2\\");
 400         }
 401 }