shell/source/unix/sysshell/recently_used_file.cxx

   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: recently_used_file.cxx,v $
  10  * $Revision: 1.7.30.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 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_shell.hxx"
  33
  34 #ifndef INCLUDED_RECENTLY_USED_FILE
  35 #include "recently_used_file.hxx"
  36 #endif
  37 #include <rtl/ustring.hxx>
  38 #include <osl/process.h>
  39 #include <osl/security.hxx>
  40 #include <osl/thread.h>
  41 #include <osl/file.hxx>
  42
  43 #include <sys/file.h>
  44 #include <sys/types.h>
  45 #include <sys/stat.h>
  46
  47 #include <unistd.h>
  48
  49 const rtl::OUString RECENTLY_USED_FILE_NAME = rtl::OUString::createFromAscii(".recently-used");
  50 const rtl::OUString SLASH = rtl::OUString::createFromAscii("/");
  51
  52 namespace /* private */ {
  53
  54 inline void ensure_final_slash(/*inout*/ rtl::OUString& path)
  55 {
  56     if ((path.getLength() > 0) &&
  57         (SLASH.pData->buffer[0] != path.pData->buffer[path.getLength() - 1]))
  58         path += SLASH;
  59 }
  60
  61 } // namespace private
  62
  63 //------------------------------------------------
  64 recently_used_file::recently_used_file() :
  65     file_(NULL)
  66 {
  67     osl::Security sec;
  68     rtl::OUString homedir_url;
  69
  70     if (sec.getHomeDir(homedir_url))
  71     {
  72         rtl::OUString homedir;
  73         osl::FileBase::getSystemPathFromFileURL(homedir_url, homedir);
  74
  75         rtl::OUString rufn = homedir;
  76         ensure_final_slash(rufn);
  77         rufn += RECENTLY_USED_FILE_NAME;
  78
  79         rtl::OString tmp =
  80             rtl::OUStringToOString(rufn, osl_getThreadTextEncoding());
  81
  82         file_ = fopen(tmp.getStr(), "r+");
  83
  84         /* create if not exist */
  85         if (NULL == file_) {
  86             mode_t umask_ = umask(S_IRGRP|S_IWGRP|S_IROTH|S_IWOTH);
  87             file_ = fopen(tmp.getStr(), "w+");
  88             umask(umask_);
  89         }
  90
  91         if (NULL == file_)
  92             throw "I/O error opening ~/.recently-used";
  93
  94         if (lockf(fileno(file_), F_LOCK, 0) != 0)
  95         {
  96             fclose(file_);
  97             throw "Cannot lock ~/.recently-used";
  98         }
  99     }
 100     else
 101         throw "Cannot determine user home directory";
 102 }
 103
 104 //------------------------------------------------
 105 recently_used_file::~recently_used_file()
 106 {
 107     lockf(fileno(file_), F_ULOCK, 0);
 108     fclose(file_);
 109 }
 110
 111 //------------------------------------------------
 112 void recently_used_file::reset() const
 113 {
 114     rewind(file_);
 115 }
 116
 117 //------------------------------------------------
 118 void recently_used_file::flush()
 119 {
 120     fflush(file_);
 121 }
 122
 123 //------------------------------------------------
 124 void recently_used_file::truncate(off_t length)
 125 {
 126     ftruncate(fileno(file_), length);
 127 }
 128
 129 //------------------------------------------------
 130 size_t recently_used_file::read(char* buffer, size_t size) const
 131 {
 132     size_t      r = fread(reinterpret_cast<void*>(buffer), sizeof(char), size, file_);
 133
 134     if ((r < size) && ferror(file_))
 135         throw "I/O error: read failed";
 136
 137     return r;
 138 }
 139
 140 //----------------------------
 141 void recently_used_file::write(const char* buffer, size_t size) const
 142 {
 143     if (size != fwrite(reinterpret_cast<const void*>(buffer), sizeof(char), size, file_))
 144         throw "I/O error: write failed";
 145 }
 146
 147 //----------------------------
 148 bool recently_used_file::eof() const
 149 {
 150     return feof(file_);
 151 }
 152
 153
 154
 155