Back to index

lightning-sunbird  0.9+nobinonly
fileurl.h
Go to the documentation of this file.
00001 /* ***** BEGIN LICENSE BLOCK *****
00002  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00003  *
00004  * The contents of this file are subject to the Mozilla Public License Version
00005  * 1.1 (the "License"); you may not use this file except in compliance with
00006  * the License. You may obtain a copy of the License at
00007  * http://www.mozilla.org/MPL/
00008  *
00009  * Software distributed under the License is distributed on an "AS IS" basis,
00010  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00011  * for the specific language governing rights and limitations under the
00012  * License.
00013  *
00014  * The Original Code is Mozilla Communicator client code, released
00015  * March 31, 1998.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998-1999
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 /*
00039  *  LDAP tools fileurl.h -- defines for file URL functions.
00040  *  Used by ldapmodify.
00041  */
00042 
00043 /*
00044  * ldaptool_fileurl2path() convert a file URL to a local path.
00045  *
00046  * If successful, LDAPTOOL_FILEURL_SUCCESS is returned and *localpathp is
00047  * set point to an allocated string.  If not, a different LDAPTOOL_FILEURL_
00048  * error code is returned.
00049  */
00050 int ldaptool_fileurl2path( const char *fileurl, char **localpathp );
00051 
00052 
00053 /*
00054  * Convert a local path to a file URL.
00055  *
00056  * If successful, LDAPTOOL_FILEURL_SUCCESS is returned and *urlp is
00057  * set point to an allocated string.  If not, a different LDAPTOOL_FILEURL_
00058  * error code is returned.  At present, the only possible error is
00059  * LDAPTOOL_FILEURL_NOMEMORY.
00060  *
00061  */
00062 int ldaptool_path2fileurl( char *path, char **urlp );
00063 
00064 
00065 /*
00066  * Populate *bvp from "value" of length "vlen."
00067  *
00068  * If recognize_url_syntax is non-zero, :<fileurl is recognized.
00069  * If always_try_file is recognized and no file URL was found, an
00070  * attempt is made to stat and read the value as if it were the name
00071  * of a file.
00072  *
00073  * If reporterrs is non-zero, specific error messages are printed to
00074  * stderr.
00075  *
00076  * If successful, LDAPTOOL_FILEURL_SUCCESS is returned and bvp->bv_len
00077  * and bvp->bv_val are set (the latter is set to malloc'd memory).
00078  * Upon failure, a different LDAPTOOL_FILEURL_ error code is returned.
00079  */
00080 int ldaptool_berval_from_ldif_value( const char *value, int vlen,
00081        struct berval *bvp, int recognize_url_syntax, int always_try_file,
00082        int reporterrs );
00083 
00084 
00085 /*
00086  * Map an LDAPTOOL_FILEURL_ error code to an LDAP error code (crude).
00087  */
00088 int ldaptool_fileurlerr2ldaperr( int lderr );
00089 
00090 
00091 /*
00092  * Possible return codes for the functions declared in this file:
00093  */
00094 #define LDAPTOOL_FILEURL_SUCCESS   0
00095 #define LDAPTOOL_FILEURL_NOTAFILEURL      1
00096 #define LDAPTOOL_FILEURL_MISSINGPATH      2
00097 #define LDAPTOOL_FILEURL_NONLOCAL  3
00098 #define LDAPTOOL_FILEURL_NOMEMORY  4
00099 #define LDAPTOOL_FILEURL_FILEIOERROR      5