gio/gfileattribute.c

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2006-2007 Red Hat, Inc.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General
  16  * Public License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  *
  20  * Author: Alexander Larsson <alexl@redhat.com>
  21  */
  22
  23 #include "config.h"
  24
  25 #include <string.h>
  26
  27 #include "gfileattribute.h"
  28 #include "gfileattribute-priv.h"
  29 #include <glib-object.h>
  30 #include "glibintl.h"
  31
  32 #include "gioalias.h"
  33
  34 /**
  35  * SECTION:gfileattribute
  36  * @short_description: Key-Value Paired File Attributes
  37  * @include: gio/gio.h
  38  * @see_also: #GFile, #GFileInfo
  39  *
  40  * File attributes in GIO consist of a list of key-value pairs.
  41  *
  42  * Keys are strings that contain a key namespace and a key name, separated
  43  * by a colon, e.g. "namespace:keyname". Namespaces are included to sort
  44  * key-value pairs by namespaces for relevance. Keys can be retrived
  45  * using wildcards, e.g. "standard::*" will return all of the keys in the
  46  * "standard" namespace.
  47  *
  48  * Values are stored within the list in #GFileAttributeValue structures.
  49  * Values can store different types, listed in the enum #GFileAttributeType.
  50  * Upon creation of a #GFileAttributeValue, the type will be set to
  51  * %G_FILE_ATTRIBUTE_TYPE_INVALID.
  52  *
  53  * The list of possible attributes for a filesystem (pointed to by a #GFile) is
  54  * availible as a #GFileAttributeInfoList. This list is queryable by key names
  55  * as indicated earlier.
  56  *
  57  * Classes that implement #GFileIface will create a #GFileAttributeInfoList and
  58  * install default keys and values for their given file system, architecture,
  59  * and other possible implementation details (e.g., on a UNIX system, a file
  60  * attribute key will be registered for the user id for a given file).
  61  *
  62  * <para>
  63  * <table>
  64  * <title>GFileAttributes Default Namespaces</title>
  65  * <tgroup cols='2' align='left'><thead>
  66  * <row><entry>Namspace</entry><entry>Description</entry></row>
  67  * </thead>
  68  * <tbody>
  69  * <row><entry>"standard"</entry><entry>The "Standard" namespace. General file
  70  * information that any application may need should be put in this namespace.
  71  * Examples include the file's name, type, and size.</entry></row>
  72  * <row><entry>"etag"</entry><entry>The <link linkend="gfile-etag">"Entity Tag"</link>
  73  * namespace. Currently, the only key in this namespace is "value", which contains
  74  * the value of the current entity tag.</entry></row>
  75  * <row><entry>"id"</entry><entry>The "Identification" namespace. This
  76  * namespace is used by file managers and applications that list directories
  77  * to check for loops and to uniquely identify files.</entry></row>
  78  * <row><entry>"access"</entry><entry>The "Access" namespace. Used to check
  79  * if a user has the proper privilidges to access files and perform
  80  * file operations. Keys in this namespace are made to be generic
  81  * and easily understood, e.g. the "can_read" key is %TRUE if
  82  * the current user has permission to read the file. UNIX permissions and
  83  * NTFS ACLs in Windows should be mapped to these values.</entry></row>
  84  * <row><entry>"mountable"</entry><entry>The "Mountable" namespace. Includes
  85  * simple boolean keys for checking if a file or path supports mount operations, e.g.
  86  * mount, unmount, eject. These are used for files of type %G_FILE_TYPE_MOUNTABLE.</entry></row>
  87  * <row><entry>"time"</entry><entry>The "Time" namespace. Includes file
  88  * access, changed, created times. </entry></row>
  89  * <row><entry>"unix"</entry><entry>The "Unix" namespace. Includes UNIX-specific
  90  * information and may not be available for all files. Examples include
  91  * the UNIX "UID", "GID", etc.</entry></row>
  92  * <row><entry>"dos"</entry><entry>The "DOS" namespace. Includes DOS-specific
  93  * information and may not be available for all files. Examples include
  94  * "is_system" for checking if a file is marked as a system file, and "is_archive"
  95  * for checking if a file is marked as an archive file.</entry></row>
  96  * <row><entry>"owner"</entry><entry>The "Owner" namespace. Includes information
  97  * about who owns a file. May not be available for all file systems. Examples include
  98  * "user" for getting the user name of the file owner. This information is often mapped from
  99  * some backend specific data such as a unix UID.</entry></row>
 100  * <row><entry>"thumbnail"</entry><entry>The "Thumbnail" namespace. Includes
 101  * information about file thumbnails and their location within the file system. Exaples of
 102  * keys in this namespace include "path" to get the location of a thumbnail, and "failed"
 103  * to check if thumbnailing of the file failed.</entry></row>
 104  * <row><entry>"filesystem"</entry><entry>The "Filesystem" namespace. Gets information
 105  * about the file system where a file is located, such as its type, how much
 106  * space is left available, and the overall size of the file system.</entry></row>
 107  * <row><entry>"gvfs"</entry><entry>The "GVFS" namespace. Keys in this namespace
 108  * contain information about the current GVFS backend in use. </entry></row>
 109  * <row><entry>"xattr"</entry><entry>The "xattr" namespace. Gets information
 110  * about extended user attributes. See attr(5). The "user." prefix of the
 111  * extended user attribute name is stripped away when constructing keys in
 112  * this namespace, e.g. "xattr::mime_type" for the extended attribute with
 113  * the name "user.mime_type". Note that this information is only available
 114  * if GLib has been built with extended attribute support.</entry></row>
 115  * <row><entry>"xattr-sys"</entry><entry>The "xattr-sys" namespace.
 116  * Gets information about extended attributes which are not user-specific.
 117  * See attr(5). Note that this information is only available if GLib
 118  * has been built with extended attribute support.</entry></row>
 119  * <row><entry>"selinux"</entry><entry>The "SELinux" namespace. Includes
 120  * information about the SELinux context of files. Note that this information
 121  * is only available if GLib has been built with SELinux support.</entry></row>
 122  * </tbody>
 123  * </tgroup>
 124  * </table>
 125  * </para>
 126  *
 127  * Please note that these are not all of the possible namespaces.
 128  * More namespaces can be added from GIO modules or by individual applications.
 129  * For more information about writing GIO modules, see #GIOModule.
 130  *
 131  * <!-- TODO: Implementation note about using extended attributes on supported
 132  * file systems -->
 133  *
 134  * <para><table>
 135  * <title>GFileAttributes Built-in Keys and Value Types</title>
 136  * <tgroup cols='3' align='left'><thead>
 137  * <row><entry>Enum Value</entry><entry>Namespace:Key</entry><entry>Value Type</entry></row>
 138  * </thead><tbody>
 139  * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_TYPE</entry><entry>standard::type</entry><entry>uint32 (#GFileType)</entry></row>
 140  * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_IS_HIDDEN</entry><entry>standard::is-hidden</entry><entry>boolean</entry></row>
 141  * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_IS_BACKUP</entry><entry>standard::is-backup</entry><entry>boolean</entry></row>
 142  * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_IS_SYMLINK</entry><entry>standard::is-symlink</entry><entry>boolean</entry></row>
 143  * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_IS_VIRTUAL</entry><entry>standard::is-virtual</entry><entry>boolean</entry></row>
 144  * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_NAME</entry><entry>standard::name</entry><entry>byte string</entry></row>
 145  * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME</entry><entry>standard::display-name</entry><entry>string</entry></row>
 146  * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME</entry><entry>standard::edit-name</entry><entry>string</entry></row>
 147  * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_ICON</entry><entry>standard::icon</entry><entry>object (#GIcon)</entry></row>
 148  * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE</entry><entry>standard::content-type</entry><entry>string</entry></row>
 149  * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_FAST_CONTENT_TYPE</entry><entry>standard::fast-content-type</entry><entry>string</entry></row>
 150  * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_SIZE</entry><entry>standard::size</entry><entry>uint64</entry></row>
 151  * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_ALLOCATED_SIZE</entry><entry>standard::allocated-size</entry><entry>uint64</entry></row>
 152  * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET</entry><entry>standard::symlink-target</entry><entry>byte string</entry></row>
 153  * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_TARGET_URI</entry><entry>standard::target-uri</entry><entry>string</entry></row>
 154  * <row><entry>%G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER</entry><entry>standard::sort-order</entry><entry>int32</entry></row>
 155  * <row><entry>%G_FILE_ATTRIBUTE_ETAG_VALUE</entry><entry>etag::value</entry><entry>string</entry></row>
 156  * <row><entry>%G_FILE_ATTRIBUTE_ID_FILE</entry><entry>id::file</entry><entry>string</entry></row>
 157  * <row><entry>%G_FILE_ATTRIBUTE_ID_FILESYSTEM</entry><entry>id::filesystem</entry><entry>string</entry></row>
 158  * <row><entry>%G_FILE_ATTRIBUTE_ACCESS_CAN_READ</entry><entry>access::can-read</entry><entry>boolean</entry></row>
 159  * <row><entry>%G_FILE_ATTRIBUTE_ACCESS_CAN_WRITE</entry><entry>access::can-write</entry><entry>boolean</entry></row>
 160  * <row><entry>%G_FILE_ATTRIBUTE_ACCESS_CAN_EXECUTE</entry><entry>access::can-execute</entry><entry>boolean</entry></row>
 161  * <row><entry>%G_FILE_ATTRIBUTE_ACCESS_CAN_DELETE</entry><entry>access::can-delete</entry><entry>boolean</entry></row>
 162  * <row><entry>%G_FILE_ATTRIBUTE_ACCESS_CAN_TRASH</entry><entry>access::can-trash</entry><entry>boolean</entry></row>
 163  * <row><entry>%G_FILE_ATTRIBUTE_ACCESS_CAN_RENAME</entry><entry>access::can-rename</entry><entry>boolean</entry></row>
 164  * <row><entry>%G_FILE_ATTRIBUTE_MOUNTABLE_CAN_MOUNT</entry><entry>mountable::can-mount</entry><entry>boolean</entry></row>
 165  * <row><entry>%G_FILE_ATTRIBUTE_MOUNTABLE_CAN_UNMOUNT</entry><entry>mountable::can-unmount</entry><entry>boolean</entry></row>
 166  * <row><entry>%G_FILE_ATTRIBUTE_MOUNTABLE_CAN_EJECT</entry><entry>mountable::can-eject</entry><entry>boolean</entry></row>
 167  * <row><entry>%G_FILE_ATTRIBUTE_MOUNTABLE_UNIX_DEVICE</entry><entry>mountable::unix-device</entry><entry>uint32</entry></row>
 168  * <row><entry>%G_FILE_ATTRIBUTE_MOUNTABLE_HAL_UDI</entry><entry>mountable::hal-udi</entry><entry>string</entry></row>
 169  * <row><entry>%G_FILE_ATTRIBUTE_TIME_MODIFIED</entry><entry>time::modified</entry><entry>uint64</entry></row>
 170  * <row><entry>%G_FILE_ATTRIBUTE_TIME_MODIFIED_USEC</entry><entry>time::modified-usec</entry><entry>uint32</entry></row>
 171  * <row><entry>%G_FILE_ATTRIBUTE_TIME_ACCESS</entry><entry>time::access</entry><entry>uint64</entry></row>
 172  * <row><entry>%G_FILE_ATTRIBUTE_TIME_ACCESS_USEC</entry><entry>time::access-usec</entry><entry>uint32</entry></row>
 173  * <row><entry>%G_FILE_ATTRIBUTE_TIME_CHANGED</entry><entry>time::changed</entry><entry>uint64</entry></row>
 174  * <row><entry>%G_FILE_ATTRIBUTE_TIME_CHANGED_USEC</entry><entry>time::changed-usec</entry><entry>uint32</entry></row>
 175  * <row><entry>%G_FILE_ATTRIBUTE_TIME_CREATED</entry><entry>time::created</entry><entry>uint64</entry></row>
 176  * <row><entry>%G_FILE_ATTRIBUTE_TIME_CREATED_USEC</entry><entry>time::created-usec</entry><entry>uint32</entry></row>
 177  * <row><entry>%G_FILE_ATTRIBUTE_UNIX_DEVICE</entry><entry>unix::device</entry><entry>uint32</entry></row>
 178  * <row><entry>%G_FILE_ATTRIBUTE_UNIX_INODE</entry><entry>unix::inode</entry><entry>uint64</entry></row>
 179  * <row><entry>%G_FILE_ATTRIBUTE_UNIX_MODE</entry><entry>unix::mode</entry><entry>uint32</entry></row>
 180  * <row><entry>%G_FILE_ATTRIBUTE_UNIX_NLINK</entry><entry>unix::nlink</entry><entry>uint32</entry></row>
 181  * <row><entry>%G_FILE_ATTRIBUTE_UNIX_UID</entry><entry>unix::uid</entry><entry>uint32</entry></row>
 182  * <row><entry>%G_FILE_ATTRIBUTE_UNIX_GID</entry><entry>unix::gid</entry><entry>uint32</entry></row>
 183  * <row><entry>%G_FILE_ATTRIBUTE_UNIX_RDEV</entry><entry>unix::rdev</entry><entry>uint32</entry></row>
 184  * <row><entry>%G_FILE_ATTRIBUTE_UNIX_BLOCK_SIZE</entry><entry>unix::block-size</entry><entry>uint32</entry></row>
 185  * <row><entry>%G_FILE_ATTRIBUTE_UNIX_BLOCKS</entry><entry>unix::blocks</entry><entry>uint64</entry></row>
 186  * <row><entry>%G_FILE_ATTRIBUTE_UNIX_IS_MOUNTPOINT</entry><entry>unix::is-mountpoint</entry><entry>boolean</entry></row>
 187  * <row><entry>%G_FILE_ATTRIBUTE_DOS_IS_ARCHIVE</entry><entry>dos::is-archive</entry><entry>boolean</entry></row>
 188  * <row><entry>%G_FILE_ATTRIBUTE_DOS_IS_SYSTEM</entry><entry>dos::is-system</entry><entry>boolean</entry></row>
 189  * <row><entry>%G_FILE_ATTRIBUTE_OWNER_USER</entry><entry>owner::user</entry><entry>string</entry></row>
 190  * <row><entry>%G_FILE_ATTRIBUTE_OWNER_USER_REAL</entry><entry>owner::user-real</entry><entry>string</entry></row>
 191  * <row><entry>%G_FILE_ATTRIBUTE_OWNER_GROUP</entry><entry>owner::group</entry><entry>string</entry></row>
 192  * <row><entry>%G_FILE_ATTRIBUTE_THUMBNAIL_PATH</entry><entry>thumbnail::path</entry><entry>bytestring</entry></row>
 193  * <row><entry>%G_FILE_ATTRIBUTE_THUMBNAILING_FAILED</entry><entry>thumbnail::failed</entry><entry>boolean</entry></row>
 194  * <row><entry>%G_FILE_ATTRIBUTE_PREVIEW_ICON</entry><entry>preview::icon</entry><entry>object (#GIcon)</entry></row>
 195  * <row><entry>%G_FILE_ATTRIBUTE_FILESYSTEM_SIZE</entry><entry>filesystem::size</entry><entry>uint64</entry></row>
 196  * <row><entry>%G_FILE_ATTRIBUTE_FILESYSTEM_FREE</entry><entry>filesystem::free</entry><entry>uint64</entry></row>
 197  * <row><entry>%G_FILE_ATTRIBUTE_FILESYSTEM_TYPE</entry><entry>filesystem::type</entry><entry>string</entry></row>
 198  * <row><entry>%G_FILE_ATTRIBUTE_FILESYSTEM_READONLY</entry><entry>filesystem::readonly</entry><entry>boolean</entry></row>
 199  * <row><entry>%G_FILE_ATTRIBUTE_GVFS_BACKEND</entry><entry>gvfs::backend</entry><entry>string</entry></row>
 200  * <row><entry>%G_FILE_ATTRIBUTE_SELINUX_CONTEXT</entry><entry>selinux::context</entry><entry>string</entry></row>
 201  * </tbody></tgroup></table></para>
 202  *
 203  * Note that there are no predefined keys in the "xattr" and "xattr-sys"
 204  * namespaces. Keys for the "xattr" namespace are constructed by stripping
 205  * away the "user." prefix from the extended user attribute, and prepending
 206  * "xattr::". Keys for the "xattr-sys" namespace are constructed by
 207  * concatenating "xattr-sys::" with the extended attribute name. All extended
 208  * attribute values are returned as hex-encoded strings in which bytes outside
 209  * the ASCII range are encoded as hexadecimal escape sequences of the form
 210  * \x<replaceable>nn</replaceable>.
 211  **/
 212
 213 /*
 214  * _g_file_attribute_value_free:
 215  * @attr: a #GFileAttributeValue.
 216  *
 217  * Frees the memory used by @attr.
 218  *
 219  **/
 220 void
 221 _g_file_attribute_value_free (GFileAttributeValue *attr)
 222 {
 223   g_return_if_fail (attr != NULL);
 224
 225   _g_file_attribute_value_clear (attr);
 226   g_free (attr);
 227 }
 228
 229 /*
 230  * _g_file_attribute_value_clear:
 231  * @attr: a #GFileAttributeValue.
 232  *
 233  * Clears the value of @attr and sets its type to
 234  * %G_FILE_ATTRIBUTE_TYPE_INVALID.
 235  *
 236  **/
 237 void
 238 _g_file_attribute_value_clear (GFileAttributeValue *attr)
 239 {
 240   g_return_if_fail (attr != NULL);
 241
 242   if (attr->type == G_FILE_ATTRIBUTE_TYPE_STRING ||
 243       attr->type == G_FILE_ATTRIBUTE_TYPE_BYTE_STRING)
 244     g_free (attr->u.string);
 245
 246   if (attr->type == G_FILE_ATTRIBUTE_TYPE_STRINGV)
 247     g_strfreev (attr->u.stringv);
 248
 249   if (attr->type == G_FILE_ATTRIBUTE_TYPE_OBJECT &&
 250       attr->u.obj != NULL)
 251     g_object_unref (attr->u.obj);
 252
 253   attr->type = G_FILE_ATTRIBUTE_TYPE_INVALID;
 254 }
 255
 256 /*
 257  * g_file_attribute_value_set:
 258  * @attr: a #GFileAttributeValue to set the value in.
 259  * @new_value: a #GFileAttributeValue to get the value from.
 260  *
 261  * Sets an attribute's value from another attribute.
 262  **/
 263 void
 264 _g_file_attribute_value_set (GFileAttributeValue        *attr,
 265                              const GFileAttributeValue *new_value)
 266 {
 267   g_return_if_fail (attr != NULL);
 268   g_return_if_fail (new_value != NULL);
 269
 270   _g_file_attribute_value_clear (attr);
 271   *attr = *new_value;
 272
 273   if (attr->type == G_FILE_ATTRIBUTE_TYPE_STRING ||
 274       attr->type == G_FILE_ATTRIBUTE_TYPE_BYTE_STRING)
 275     attr->u.string = g_strdup (attr->u.string);
 276
 277   if (attr->type == G_FILE_ATTRIBUTE_TYPE_STRINGV)
 278     attr->u.stringv = g_strdupv (attr->u.stringv);
 279
 280   if (attr->type == G_FILE_ATTRIBUTE_TYPE_OBJECT &&
 281       attr->u.obj != NULL)
 282     g_object_ref (attr->u.obj);
 283 }
 284
 285 /*
 286  * _g_file_attribute_value_new:
 287  *
 288  * Creates a new file attribute.
 289  *
 290  * Returns: a #GFileAttributeValue.
 291  **/
 292 GFileAttributeValue *
 293 _g_file_attribute_value_new (void)
 294 {
 295   GFileAttributeValue *attr;
 296
 297   attr = g_new (GFileAttributeValue, 1);
 298   attr->type = G_FILE_ATTRIBUTE_TYPE_INVALID;
 299   return attr;
 300 }
 301
 302 gpointer
 303 _g_file_attribute_value_peek_as_pointer (GFileAttributeValue *attr)
 304 {
 305   switch (attr->type) {
 306   case G_FILE_ATTRIBUTE_TYPE_STRING:
 307   case G_FILE_ATTRIBUTE_TYPE_BYTE_STRING:
 308     return attr->u.string;
 309   case G_FILE_ATTRIBUTE_TYPE_STRINGV:
 310     return attr->u.stringv;
 311   case G_FILE_ATTRIBUTE_TYPE_OBJECT:
 312     return attr->u.obj;
 313   default:
 314     return (gpointer) &attr->u;
 315   }
 316 }
 317
 318 /*
 319  * g_file_attribute_value_dup:
 320  * @other: a #GFileAttributeValue to duplicate.
 321  *
 322  * Duplicates a file attribute.
 323  *
 324  * Returns: a duplicate of the @other.
 325  **/
 326 GFileAttributeValue *
 327 _g_file_attribute_value_dup (const GFileAttributeValue *other)
 328 {
 329   GFileAttributeValue *attr;
 330
 331   g_return_val_if_fail (other != NULL, NULL);
 332
 333   attr = g_new (GFileAttributeValue, 1);
 334   attr->type = G_FILE_ATTRIBUTE_TYPE_INVALID;
 335   _g_file_attribute_value_set (attr, other);
 336   return attr;
 337 }
 338
 339 GType
 340 g_file_attribute_info_list_get_type (void)
 341 {
 342   static volatile gsize g_define_type_id__volatile = 0;
 343
 344   if (g_once_init_enter (&g_define_type_id__volatile))
 345     {
 346       GType g_define_type_id =
 347         g_boxed_type_register_static (I_("GFileAttributeInfoList"),
 348                                       (GBoxedCopyFunc) g_file_attribute_info_list_dup,
 349                                       (GBoxedFreeFunc) g_file_attribute_info_list_unref);
 350
 351       g_once_init_leave (&g_define_type_id__volatile, g_define_type_id);
 352     }
 353
 354   return g_define_type_id__volatile;
 355 }
 356
 357 static gboolean
 358 valid_char (char c)
 359 {
 360   return c >= 32 && c <= 126 && c != '\\';
 361 }
 362
 363 static char *
 364 escape_byte_string (const char *str)
 365 {
 366   size_t len;
 367   int num_invalid, i;
 368   char *escaped_val, *p;
 369   unsigned char c;
 370   const char hex_digits[] = "0123456789abcdef";
 371
 372   len = strlen (str);
 373
 374   num_invalid = 0;
 375   for (i = 0; i < len; i++)
 376     {
 377       if (!valid_char (str[i]))
 378         num_invalid++;
 379     }
 380
 381   if (num_invalid == 0)
 382     return g_strdup (str);
 383   else
 384     {
 385       escaped_val = g_malloc (len + num_invalid*3 + 1);
 386
 387       p = escaped_val;
 388       for (i = 0; i < len; i++)
 389         {
 390           c = str[i];
 391           if (valid_char (c))
 392             *p++ = c;
 393           else
 394             {
 395               *p++ = '\\';
 396               *p++ = 'x';
 397               *p++ = hex_digits[(c >> 4) & 0xf];
 398               *p++ = hex_digits[c & 0xf];
 399             }
 400         }
 401       *p++ = 0;
 402       return escaped_val;
 403     }
 404 }
 405
 406 /*
 407  * _g_file_attribute_value_as_string:
 408  * @attr: a #GFileAttributeValue.
 409  *
 410  * Converts a #GFileAttributeValue to a string for display.
 411  * The returned string should be freed when no longer needed.
 412  *
 413  * Returns: a string from the @attr, %NULL on error, or "&lt;invalid&gt;"
 414  * if @attr is of type %G_FILE_ATTRIBUTE_TYPE_INVALID.
 415  */
 416 char *
 417 _g_file_attribute_value_as_string (const GFileAttributeValue *attr)
 418 {
 419   GString *s;
 420   int i;
 421   char *str;
 422
 423   g_return_val_if_fail (attr != NULL, NULL);
 424
 425   switch (attr->type)
 426     {
 427     case G_FILE_ATTRIBUTE_TYPE_STRING:
 428       str = g_strdup (attr->u.string);
 429       break;
 430     case G_FILE_ATTRIBUTE_TYPE_STRINGV:
 431       s = g_string_new ("[");
 432       for (i = 0; attr->u.stringv[i] != NULL; i++)
 433         {
 434           g_string_append (s, attr->u.stringv[i]);
 435           if (attr->u.stringv[i+1] != NULL)
 436             g_string_append (s, ", ");
 437         }
 438       g_string_append (s, "]");
 439       str = g_string_free (s, FALSE);
 440       break;
 441     case G_FILE_ATTRIBUTE_TYPE_BYTE_STRING:
 442       str = escape_byte_string (attr->u.string);
 443       break;
 444     case G_FILE_ATTRIBUTE_TYPE_BOOLEAN:
 445       str = g_strdup_printf ("%s", attr->u.boolean?"TRUE":"FALSE");
 446       break;
 447     case G_FILE_ATTRIBUTE_TYPE_UINT32:
 448       str = g_strdup_printf ("%u", (unsigned int)attr->u.uint32);
 449       break;
 450     case G_FILE_ATTRIBUTE_TYPE_INT32:
 451       str = g_strdup_printf ("%i", (int)attr->u.int32);
 452       break;
 453     case G_FILE_ATTRIBUTE_TYPE_UINT64:
 454       str = g_strdup_printf ("%"G_GUINT64_FORMAT, attr->u.uint64);
 455       break;
 456     case G_FILE_ATTRIBUTE_TYPE_INT64:
 457       str = g_strdup_printf ("%"G_GINT64_FORMAT, attr->u.int64);
 458       break;
 459     case G_FILE_ATTRIBUTE_TYPE_OBJECT:
 460       str = g_strdup_printf ("%s:%p", g_type_name_from_instance
 461                                           ((GTypeInstance *) attr->u.obj),
 462                                       attr->u.obj);
 463       break;
 464     default:
 465       g_warning ("Invalid type in GFileInfo attribute");
 466       str = g_strdup ("<invalid>");
 467       break;
 468     }
 469
 470   return str;
 471 }
 472
 473 /*
 474  * _g_file_attribute_value_get_string:
 475  * @attr: a #GFileAttributeValue.
 476  *
 477  * Gets the string from a file attribute value. If the value is not the
 478  * right type then %NULL will be returned.
 479  *
 480  * Returns: the string value contained within the attribute, or %NULL.
 481  */
 482 const char *
 483 _g_file_attribute_value_get_string (const GFileAttributeValue *attr)
 484 {
 485   if (attr == NULL)
 486     return NULL;
 487
 488   g_return_val_if_fail (attr->type == G_FILE_ATTRIBUTE_TYPE_STRING, NULL);
 489
 490   return attr->u.string;
 491 }
 492
 493 /*
 494  * _g_file_attribute_value_get_byte_string:
 495  * @attr: a #GFileAttributeValue.
 496  *
 497  * Gets the byte string from a file attribute value. If the value is not the
 498  * right type then %NULL will be returned.
 499  *
 500  * Returns: the byte string contained within the attribute or %NULL.
 501  */
 502 const char *
 503 _g_file_attribute_value_get_byte_string (const GFileAttributeValue *attr)
 504 {
 505   if (attr == NULL)
 506     return NULL;
 507
 508   g_return_val_if_fail (attr->type == G_FILE_ATTRIBUTE_TYPE_BYTE_STRING, NULL);
 509
 510   return attr->u.string;
 511 }
 512
 513 char **
 514 _g_file_attribute_value_get_stringv (const GFileAttributeValue *attr)
 515 {
 516   if (attr == NULL)
 517     return NULL;
 518
 519   g_return_val_if_fail (attr->type == G_FILE_ATTRIBUTE_TYPE_STRINGV, NULL);
 520
 521   return attr->u.stringv;
 522 }
 523
 524 /*
 525  * _g_file_attribute_value_get_boolean:
 526  * @attr: a #GFileAttributeValue.
 527  *
 528  * Gets the boolean value from a file attribute value. If the value is not the
 529  * right type then %FALSE will be returned.
 530  *
 531  * Returns: the boolean value contained within the attribute, or %FALSE.
 532  */
 533 gboolean
 534 _g_file_attribute_value_get_boolean (const GFileAttributeValue *attr)
 535 {
 536   if (attr == NULL)
 537     return FALSE;
 538
 539   g_return_val_if_fail (attr->type == G_FILE_ATTRIBUTE_TYPE_BOOLEAN, FALSE);
 540
 541   return attr->u.boolean;
 542 }
 543
 544 /*
 545  * _g_file_attribute_value_get_uint32:
 546  * @attr: a #GFileAttributeValue.
 547  *
 548  * Gets the unsigned 32-bit integer from a file attribute value. If the value
 549  * is not the right type then 0 will be returned.
 550  *
 551  * Returns: the unsigned 32-bit integer from the attribute, or 0.
 552  */
 553 guint32
 554 _g_file_attribute_value_get_uint32 (const GFileAttributeValue *attr)
 555 {
 556   if (attr == NULL)
 557     return 0;
 558
 559   g_return_val_if_fail (attr->type == G_FILE_ATTRIBUTE_TYPE_UINT32, 0);
 560
 561   return attr->u.uint32;
 562 }
 563
 564 /*
 565  * _g_file_attribute_value_get_int32:
 566  * @attr: a #GFileAttributeValue.
 567  *
 568  * Gets the signed 32-bit integer from a file attribute value. If the value
 569  * is not the right type then 0 will be returned.
 570  *
 571  * Returns: the signed 32-bit integer from the attribute, or 0.
 572  */
 573 gint32
 574 _g_file_attribute_value_get_int32 (const GFileAttributeValue *attr)
 575 {
 576   if (attr == NULL)
 577     return 0;
 578
 579   g_return_val_if_fail (attr->type == G_FILE_ATTRIBUTE_TYPE_INT32, 0);
 580
 581   return attr->u.int32;
 582 }
 583
 584 /*
 585  * _g_file_attribute_value_get_uint64:
 586  * @attr: a #GFileAttributeValue.
 587  *
 588  * Gets the unsigned 64-bit integer from a file attribute value. If the value
 589  * is not the right type then 0 will be returned.
 590  *
 591  * Returns: the unsigned 64-bit integer from the attribute, or 0.
 592  */
 593 guint64
 594 _g_file_attribute_value_get_uint64 (const GFileAttributeValue *attr)
 595 {
 596   if (attr == NULL)
 597     return 0;
 598
 599   g_return_val_if_fail (attr->type == G_FILE_ATTRIBUTE_TYPE_UINT64, 0);
 600
 601   return attr->u.uint64;
 602 }
 603
 604 /*
 605  * _g_file_attribute_value_get_int64:
 606  * @attr: a #GFileAttributeValue.
 607  *
 608  * Gets the signed 64-bit integer from a file attribute value. If the value
 609  * is not the right type then 0 will be returned.
 610  *
 611  * Returns: the signed 64-bit integer from the attribute, or 0.
 612  */
 613 gint64
 614 _g_file_attribute_value_get_int64 (const GFileAttributeValue *attr)
 615 {
 616   if (attr == NULL)
 617     return 0;
 618
 619   g_return_val_if_fail (attr->type == G_FILE_ATTRIBUTE_TYPE_INT64, 0);
 620
 621   return attr->u.int64;
 622 }
 623
 624 /*
 625  * _g_file_attribute_value_get_object:
 626  * @attr: a #GFileAttributeValue.
 627  *
 628  * Gets the GObject from a file attribute value. If the value
 629  * is not the right type then %NULL will be returned.
 630  *
 631  * Returns: the GObject from the attribute, or %NULL.
 632  **/
 633 GObject *
 634 _g_file_attribute_value_get_object (const GFileAttributeValue *attr)
 635 {
 636   if (attr == NULL)
 637     return NULL;
 638
 639   g_return_val_if_fail (attr->type == G_FILE_ATTRIBUTE_TYPE_OBJECT, NULL);
 640
 641   return attr->u.obj;
 642 }
 643
 644
 645 void
 646 _g_file_attribute_value_set_from_pointer (GFileAttributeValue *value,
 647                                           GFileAttributeType   type,
 648                                           gpointer             value_p,
 649                                           gboolean             dup)
 650 {
 651   _g_file_attribute_value_clear (value);
 652   value->type = type;
 653   switch (type)
 654     {
 655     case G_FILE_ATTRIBUTE_TYPE_STRING:
 656     case G_FILE_ATTRIBUTE_TYPE_BYTE_STRING:
 657       if (dup)
 658         value->u.string = g_strdup (value_p);
 659       else
 660         value->u.string = value_p;
 661       break;
 662
 663     case G_FILE_ATTRIBUTE_TYPE_STRINGV:
 664       if (dup)
 665         value->u.stringv = g_strdupv (value_p);
 666       else
 667         value->u.stringv = value_p;
 668       break;
 669
 670     case G_FILE_ATTRIBUTE_TYPE_OBJECT:
 671       if (dup)
 672         value->u.obj = g_object_ref (value_p);
 673       else
 674         value->u.obj = value_p;
 675       break;
 676
 677     case G_FILE_ATTRIBUTE_TYPE_BOOLEAN:
 678       value->u.boolean = *(gboolean *)value_p;
 679       break;
 680
 681     case G_FILE_ATTRIBUTE_TYPE_UINT32:
 682       value->u.uint32 = *(guint32 *)value_p;
 683       break;
 684
 685     case G_FILE_ATTRIBUTE_TYPE_INT32:
 686       value->u.int32 = *(gint32 *)value_p;
 687       break;
 688
 689     case G_FILE_ATTRIBUTE_TYPE_UINT64:
 690       value->u.uint64 = *(guint64 *)value_p;
 691       break;
 692
 693     case G_FILE_ATTRIBUTE_TYPE_INT64:
 694       value->u.int64 = *(gint64 *)value_p;
 695       break;
 696     default:
 697       g_warning ("Unknown type specified in g_file_info_set_attribute\n");
 698       break;
 699     }
 700 }
 701
 702 /*
 703  * _g_file_attribute_value_set_string:
 704  * @attr: a #GFileAttributeValue.
 705  * @string: a string to set within the type.
 706  *
 707  * Sets the attribute value to a given string.
 708  */
 709 void
 710 _g_file_attribute_value_set_string (GFileAttributeValue *attr,
 711                                     const char          *string)
 712 {
 713   g_return_if_fail (attr != NULL);
 714   g_return_if_fail (string != NULL);
 715
 716   _g_file_attribute_value_clear (attr);
 717   attr->type = G_FILE_ATTRIBUTE_TYPE_STRING;
 718   attr->u.string = g_strdup (string);
 719 }
 720
 721 /*
 722  * _g_file_attribute_value_set_byte_string:
 723  * @attr: a #GFileAttributeValue.
 724  * @string: a byte string to set within the type.
 725  *
 726  * Sets the attribute value to a given byte string.
 727  */
 728 void
 729 _g_file_attribute_value_set_byte_string (GFileAttributeValue *attr,
 730                                          const char          *string)
 731 {
 732   g_return_if_fail (attr != NULL);
 733   g_return_if_fail (string != NULL);
 734
 735   _g_file_attribute_value_clear (attr);
 736   attr->type = G_FILE_ATTRIBUTE_TYPE_BYTE_STRING;
 737   attr->u.string = g_strdup (string);
 738 }
 739
 740 void
 741 _g_file_attribute_value_set_stringv (GFileAttributeValue *attr,
 742                                      char               **value)
 743 {
 744   g_return_if_fail (attr != NULL);
 745   g_return_if_fail (value != NULL);
 746
 747   _g_file_attribute_value_clear (attr);
 748   attr->type = G_FILE_ATTRIBUTE_TYPE_STRINGV;
 749   attr->u.stringv = g_strdupv (value);
 750 }
 751
 752
 753 /*
 754  * _g_file_attribute_value_set_boolean:
 755  * @attr: a #GFileAttributeValue.
 756  * @value: a #gboolean to set within the type.
 757  *
 758  * Sets the attribute value to the given boolean value.
 759  */
 760 void
 761 _g_file_attribute_value_set_boolean (GFileAttributeValue *attr,
 762                                      gboolean             value)
 763 {
 764   g_return_if_fail (attr != NULL);
 765
 766   _g_file_attribute_value_clear (attr);
 767   attr->type = G_FILE_ATTRIBUTE_TYPE_BOOLEAN;
 768   attr->u.boolean = !!value;
 769 }
 770
 771 /*
 772  * _g_file_attribute_value_set_uint32:
 773  * @attr: a #GFileAttributeValue.
 774  * @value: a #guint32 to set within the type.
 775  *
 776  * Sets the attribute value to the given unsigned 32-bit integer.
 777  */
 778 void
 779 _g_file_attribute_value_set_uint32 (GFileAttributeValue *attr,
 780                                     guint32              value)
 781 {
 782   g_return_if_fail (attr != NULL);
 783
 784   _g_file_attribute_value_clear (attr);
 785   attr->type = G_FILE_ATTRIBUTE_TYPE_UINT32;
 786   attr->u.uint32 = value;
 787 }
 788
 789 /*
 790  * _g_file_attribute_value_set_int32:
 791  * @attr: a #GFileAttributeValue.
 792  * @value: a #gint32 to set within the type.
 793  *
 794  * Sets the attribute value to the given signed 32-bit integer.
 795  */
 796 void
 797 _g_file_attribute_value_set_int32 (GFileAttributeValue *attr,
 798                                    gint32               value)
 799 {
 800   g_return_if_fail (attr != NULL);
 801
 802   _g_file_attribute_value_clear (attr);
 803   attr->type = G_FILE_ATTRIBUTE_TYPE_INT32;
 804   attr->u.int32 = value;
 805 }
 806
 807 /*
 808  * _g_file_attribute_value_set_uint64:
 809  * @attr: a #GFileAttributeValue.
 810  * @value: a #guint64 to set within the type.
 811  *
 812  * Sets the attribute value to a given unsigned 64-bit integer.
 813  */
 814 void
 815 _g_file_attribute_value_set_uint64 (GFileAttributeValue *attr,
 816                                     guint64              value)
 817 {
 818   g_return_if_fail (attr != NULL);
 819
 820   _g_file_attribute_value_clear (attr);
 821   attr->type = G_FILE_ATTRIBUTE_TYPE_UINT64;
 822   attr->u.uint64 = value;
 823 }
 824
 825 /*
 826  * _g_file_attribute_value_set_int64:
 827  * @attr: a #GFileAttributeValue.
 828  * @value: a #gint64 to set within the type.
 829  *
 830  * Sets the attribute value to a given signed 64-bit integer.
 831  */
 832 void
 833 _g_file_attribute_value_set_int64 (GFileAttributeValue *attr,
 834                                    gint64               value)
 835 {
 836   g_return_if_fail (attr != NULL);
 837
 838   _g_file_attribute_value_clear (attr);
 839   attr->type = G_FILE_ATTRIBUTE_TYPE_INT64;
 840   attr->u.int64 = value;
 841 }
 842
 843 /*
 844  * _g_file_attribute_value_set_object:
 845  * @attr: a #GFileAttributeValue.
 846  * @obj: a #GObject.
 847  *
 848  * Sets the attribute to contain the value @obj.
 849  * The @attr references the GObject internally.
 850  */
 851 void
 852 _g_file_attribute_value_set_object (GFileAttributeValue *attr,
 853                                     GObject             *obj)
 854 {
 855   g_return_if_fail (attr != NULL);
 856   g_return_if_fail (obj != NULL);
 857
 858   _g_file_attribute_value_clear (attr);
 859   attr->type = G_FILE_ATTRIBUTE_TYPE_OBJECT;
 860   attr->u.obj = g_object_ref (obj);
 861 }
 862
 863 typedef struct {
 864   GFileAttributeInfoList public;
 865   GArray *array;
 866   int ref_count;
 867 } GFileAttributeInfoListPriv;
 868
 869 static void
 870 list_update_public (GFileAttributeInfoListPriv *priv)
 871 {
 872   priv->public.infos = (GFileAttributeInfo *)priv->array->data;
 873   priv->public.n_infos = priv->array->len;
 874 }
 875
 876 /**
 877  * g_file_attribute_info_list_new:
 878  *
 879  * Creates a new file attribute info list.
 880  *
 881  * Returns: a #GFileAttributeInfoList.
 882  */
 883 GFileAttributeInfoList *
 884 g_file_attribute_info_list_new (void)
 885 {
 886   GFileAttributeInfoListPriv *priv;
 887
 888   priv = g_new0 (GFileAttributeInfoListPriv, 1);
 889
 890   priv->ref_count = 1;
 891   priv->array = g_array_new (TRUE, FALSE, sizeof (GFileAttributeInfo));
 892
 893   list_update_public (priv);
 894
 895   return (GFileAttributeInfoList *)priv;
 896 }
 897
 898 /**
 899  * g_file_attribute_info_list_dup:
 900  * @list: a #GFileAttributeInfoList to duplicate.
 901  *
 902  * Makes a duplicate of a file attribute info list.
 903  *
 904  * Returns: a copy of the given @list.
 905  */
 906 GFileAttributeInfoList *
 907 g_file_attribute_info_list_dup (GFileAttributeInfoList *list)
 908 {
 909   GFileAttributeInfoListPriv *new;
 910   int i;
 911
 912   g_return_val_if_fail (list != NULL, NULL);
 913
 914   new = g_new0 (GFileAttributeInfoListPriv, 1);
 915   new->ref_count = 1;
 916   new->array = g_array_new (TRUE, FALSE, sizeof (GFileAttributeInfo));
 917
 918   g_array_set_size (new->array, list->n_infos);
 919   list_update_public (new);
 920   for (i = 0; i < list->n_infos; i++)
 921     {
 922       new->public.infos[i].name = g_strdup (list->infos[i].name);
 923       new->public.infos[i].type = list->infos[i].type;
 924       new->public.infos[i].flags = list->infos[i].flags;
 925     }
 926
 927   return (GFileAttributeInfoList *)new;
 928 }
 929
 930 /**
 931  * g_file_attribute_info_list_ref:
 932  * @list: a #GFileAttributeInfoList to reference.
 933  *
 934  * References a file attribute info list.
 935  *
 936  * Returns: #GFileAttributeInfoList or %NULL on error.
 937  */
 938 GFileAttributeInfoList *
 939 g_file_attribute_info_list_ref (GFileAttributeInfoList *list)
 940 {
 941   GFileAttributeInfoListPriv *priv = (GFileAttributeInfoListPriv *)list;
 942
 943   g_return_val_if_fail (list != NULL, NULL);
 944   g_return_val_if_fail (priv->ref_count > 0, NULL);
 945
 946   g_atomic_int_inc (&priv->ref_count);
 947
 948   return list;
 949 }
 950
 951 /**
 952  * g_file_attribute_info_list_unref:
 953  * @list: The #GFileAttributeInfoList to unreference.
 954  *
 955  * Removes a reference from the given @list. If the reference count
 956  * falls to zero, the @list is deleted.
 957  */
 958 void
 959 g_file_attribute_info_list_unref (GFileAttributeInfoList *list)
 960 {
 961   GFileAttributeInfoListPriv *priv = (GFileAttributeInfoListPriv *)list;
 962   int i;
 963
 964   g_return_if_fail (list != NULL);
 965   g_return_if_fail (priv->ref_count > 0);
 966
 967   if (g_atomic_int_dec_and_test (&priv->ref_count))
 968     {
 969       for (i = 0; i < list->n_infos; i++)
 970         g_free (list->infos[i].name);
 971       g_array_free (priv->array, TRUE);
 972     }
 973 }
 974
 975 static int
 976 g_file_attribute_info_list_bsearch (GFileAttributeInfoList *list,
 977                                     const char             *name)
 978 {
 979   int start, end, mid;
 980
 981   start = 0;
 982   end = list->n_infos;
 983
 984   while (start != end)
 985     {
 986       mid = start + (end - start) / 2;
 987
 988       if (strcmp (name, list->infos[mid].name) < 0)
 989         end = mid;
 990       else if (strcmp (name, list->infos[mid].name) > 0)
 991         start = mid + 1;
 992       else
 993         return mid;
 994     }
 995   return start;
 996 }
 997
 998 /**
 999  * g_file_attribute_info_list_lookup:
1000  * @list: a #GFileAttributeInfoList.
1001  * @name: the name of the attribute to lookup.
1002  *
1003  * Gets the file attribute with the name @name from @list.
1004  *
1005  * Returns: a #GFileAttributeInfo for the @name, or %NULL if an
1006  * attribute isn't found.
1007  */
1008 const GFileAttributeInfo *
1009 g_file_attribute_info_list_lookup (GFileAttributeInfoList *list,
1010                                    const char             *name)
1011 {
1012   int i;
1013
1014   g_return_val_if_fail (list != NULL, NULL);
1015   g_return_val_if_fail (name != NULL, NULL);
1016
1017   i = g_file_attribute_info_list_bsearch (list, name);
1018
1019   if (i < list->n_infos && strcmp (list->infos[i].name, name) == 0)
1020     return &list->infos[i];
1021
1022   return NULL;
1023 }
1024
1025 /**
1026  * g_file_attribute_info_list_add:
1027  * @list: a #GFileAttributeInfoList.
1028  * @name: the name of the attribute to add.
1029  * @type: the #GFileAttributeType for the attribute.
1030  * @flags: #GFileAttributeInfoFlags for the attribute.
1031  *
1032  * Adds a new attribute with @name to the @list, setting
1033  * its @type and @flags.
1034  */
1035 void
1036 g_file_attribute_info_list_add (GFileAttributeInfoList *list,
1037                                 const char             *name,
1038                                 GFileAttributeType      type,
1039                                 GFileAttributeInfoFlags flags)
1040 {
1041   GFileAttributeInfoListPriv *priv = (GFileAttributeInfoListPriv *)list;
1042   GFileAttributeInfo info;
1043   int i;
1044
1045   g_return_if_fail (list != NULL);
1046   g_return_if_fail (name != NULL);
1047
1048   i = g_file_attribute_info_list_bsearch (list, name);
1049
1050   if (i < list->n_infos && strcmp (list->infos[i].name, name) == 0)
1051     {
1052       list->infos[i].type = type;
1053       return;
1054     }
1055
1056   info.name = g_strdup (name);
1057   info.type = type;
1058   info.flags = flags;
1059   g_array_insert_vals (priv->array, i, &info, 1);
1060
1061   list_update_public (priv);
1062 }
1063
1064 #define __G_FILE_ATTRIBUTE_C__
1065 #include "gioaliasdef.c"