15976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org/* 25976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * libjingle 35976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * Copyright 2004--2005, Google Inc. 45976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * 55976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * Redistribution and use in source and binary forms, with or without 65976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * modification, are permitted provided that the following conditions are met: 75976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * 85976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * 1. Redistributions of source code must retain the above copyright notice, 95976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * this list of conditions and the following disclaimer. 105976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * 2. Redistributions in binary form must reproduce the above copyright notice, 115976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * this list of conditions and the following disclaimer in the documentation 125976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * and/or other materials provided with the distribution. 135976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * 3. The name of the author may not be used to endorse or promote products 145976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * derived from this software without specific prior written permission. 155976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * 165976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 175976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 185976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO 195976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 205976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 215976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 225976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 235976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 245976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 255976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 265976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org */ 275976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 285976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org#ifndef TALK_BASE_PATHUTILS_H__ 295976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org#define TALK_BASE_PATHUTILS_H__ 305976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 315976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org#include <string> 325976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org// Temporary, until deprecated helpers are removed. 335976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org#include "talk/base/fileutils.h" 345976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 355976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.orgnamespace talk_base { 365976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 375976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org/////////////////////////////////////////////////////////////////////////////// 385976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org// Pathname - parsing of pathnames into components, and vice versa. 395976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org// 405976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org// To establish consistent terminology, a filename never contains a folder 415976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org// component. A folder never contains a filename. A pathname may include 425976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org// a folder and/or filename component. Here are some examples: 435976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org// 445976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org// pathname() /home/john/example.txt 455976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org// folder() /home/john/ 465976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org// filename() example.txt 475976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org// parent_folder() /home/ 485976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org// folder_name() john/ 495976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org// basename() example 505976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org// extension() .txt 515976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org// 525976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org// Basename may begin, end, and/or include periods, but no folder delimiters. 535976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org// If extension exists, it consists of a period followed by zero or more 545976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org// non-period/non-delimiter characters, and basename is non-empty. 555976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org/////////////////////////////////////////////////////////////////////////////// 565976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 575976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.orgclass Pathname { 585976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.orgpublic: 595976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org // Folder delimiters are slash and backslash 605976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org static bool IsFolderDelimiter(char ch); 615976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org static char DefaultFolderDelimiter(); 625976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 635976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org Pathname(); 645976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org Pathname(const std::string& pathname); 655976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org Pathname(const std::string& folder, const std::string& filename); 665976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 675976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org // Set's the default folder delimiter for this Pathname 685976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org char folder_delimiter() const { return folder_delimiter_; } 695976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org void SetFolderDelimiter(char delimiter); 705976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 715976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org // Normalize changes all folder delimiters to folder_delimiter() 725976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org void Normalize(); 735976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 745976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org // Reset to the empty pathname 755976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org void clear(); 765976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 775976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org // Returns true if the pathname is empty. Note: this->pathname().empty() 785976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org // is always false. 795976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org bool empty() const; 805976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 815976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org std::string url() const; 825976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 835976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org // Returns the folder and filename components. If the pathname is empty, 845976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org // returns a string representing the current directory (as a relative path, 855976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org // i.e., "."). 865976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org std::string pathname() const; 875976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org void SetPathname(const std::string& pathname); 885976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org void SetPathname(const std::string& folder, const std::string& filename); 895976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 905976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org // Append pathname to the current folder (if any). Any existing filename 915976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org // will be discarded. 925976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org void AppendPathname(const std::string& pathname); 935976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 945976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org std::string folder() const; 955976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org std::string folder_name() const; 965976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org std::string parent_folder() const; 975976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org // SetFolder and AppendFolder will append a folder delimiter, if needed. 985976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org void SetFolder(const std::string& folder); 995976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org void AppendFolder(const std::string& folder); 1005976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 1015976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org std::string basename() const; 1025976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org bool SetBasename(const std::string& basename); 1035976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 1045976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org std::string extension() const; 1055976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org // SetExtension will prefix a period, if needed. 1065976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org bool SetExtension(const std::string& extension); 1075976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 1085976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org std::string filename() const; 1095976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org bool SetFilename(const std::string& filename); 1105976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 1115976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org#ifdef WIN32 1125976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org bool GetDrive(char *drive, uint32 bytes) const; 1135976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org static bool GetDrive(char *drive, uint32 bytes,const std::string& pathname); 1145976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org#endif 1155976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 1165976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.orgprivate: 1175976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org std::string folder_, basename_, extension_; 1185976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org char folder_delimiter_; 1195976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org}; 1205976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 1215976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org/////////////////////////////////////////////////////////////////////////////// 1225976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org// Global Helpers (deprecated) 1235976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org/////////////////////////////////////////////////////////////////////////////// 1245976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 1255976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.orginline void SetOrganizationName(const std::string& organization) { 1265976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org Filesystem::SetOrganizationName(organization); 1275976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org} 1285976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.orginline void SetApplicationName(const std::string& application) { 1295976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org Filesystem::SetApplicationName(application); 1305976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org} 1315976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.orginline void GetOrganizationName(std::string* organization) { 1325976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org Filesystem::GetOrganizationName(organization); 1335976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org} 1345976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.orginline void GetApplicationName(std::string* application) { 1355976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org Filesystem::GetApplicationName(application); 1365976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org} 1375976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.orginline bool CreateFolder(const Pathname& path) { 1385976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org return Filesystem::CreateFolder(path); 1395976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org} 1405976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.orginline bool FinishPath(Pathname& path, bool create, const std::string& append) { 1415976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org if (!append.empty()) 1425976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org path.AppendFolder(append); 1435976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org return !create || CreateFolder(path); 1445976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org} 1455976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org// Note: this method uses the convention of <temp>/<appname> for the temporary 1465976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org// folder. Filesystem uses <temp>/<exename>. We will be migrating exclusively 1475976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org// to <temp>/<orgname>/<appname> eventually. Since these are temp folders, 1485976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org// it's probably ok to orphan them during the transition. 1495976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.orginline bool GetTemporaryFolder(Pathname& path, bool create, 1505976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org const std::string& append) { 1515976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org std::string application_name; 1525976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org Filesystem::GetApplicationName(&application_name); 1535976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org ASSERT(!application_name.empty()); 1545976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org return Filesystem::GetTemporaryFolder(path, create, &application_name) 1555976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org && FinishPath(path, create, append); 1565976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org} 1575976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.orginline bool GetAppDataFolder(Pathname& path, bool create, 1585976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org const std::string& append) { 1595976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org ASSERT(!create); // TODO: Support create flag on Filesystem::GetAppDataFolder. 1605976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org return Filesystem::GetAppDataFolder(&path, true) 1615976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org && FinishPath(path, create, append); 1625976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org} 1635976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.orginline bool CleanupTemporaryFolder() { 1645976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org Pathname path; 1655976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org if (!GetTemporaryFolder(path, false, "")) 1665976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org return false; 1675976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org if (Filesystem::IsAbsent(path)) 1685976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org return true; 1695976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org if (!Filesystem::IsTemporaryPath(path)) { 1705976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org ASSERT(false); 1715976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org return false; 1725976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org } 1735976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org return Filesystem::DeleteFolderContents(path); 1745976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org} 1755976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 1765976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org/////////////////////////////////////////////////////////////////////////////// 1775976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 1785976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org} // namespace talk_base 1795976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org 1805976650443d68ccfadf1dea24999ee459dd2819mflodman@webrtc.org#endif // TALK_BASE_PATHUTILS_H__ 181