]> git.wincent.com - mkdtemp.git/blob - ext/mkdtemp.c
775ed1d97810b35bcc288c2f09c7c41dc733e90c
[mkdtemp.git] / ext / mkdtemp.c
1 // Copyright 2007-2010 Wincent Colaiuta. All rights reserved.
2 //
3 // Redistribution and use in source and binary forms, with or without
4 // modification, are permitted provided that the following conditions are met:
5 //
6 // 1. Redistributions of source code must retain the above copyright notice,
7 //    this list of conditions and the following disclaimer.
8 // 2. Redistributions in binary form must reproduce the above copyright notice,
9 //    this list of conditions and the following disclaimer in the documentation
10 //    and/or other materials provided with the distribution.
11 //
12 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
13 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
14 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
15 // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
16 // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
17 // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
18 // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
19 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
20 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
21 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
22 // POSSIBILITY OF SUCH DAMAGE.
23
24 #include <ruby.h>
25 #include <errno.h>
26 #include <unistd.h>
27 #include "ruby_compat.h"
28
29 // helper function needed by rb_iterate; see:
30 //  http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/144100
31 VALUE call_chdir(VALUE dir)
32 {
33     return rb_funcall(rb_cDir, rb_intern("chdir"), 1, dir);
34 }
35
36 // helper function needed by rb_iterate
37 VALUE yield_block(VALUE ignored, VALUE block)
38 {
39     return rb_funcall(block, rb_intern("call"), 0);
40 }
41 /*
42  * @overload mkdtemp(template)
43  *   Securely create a temporary directory.
44  *
45  *   This method securely creates temporary directories. It is a wrapper for the
46  *   <code>mkdtemp()</code> function in the standard C library.
47  *
48  *   If supplied a block, performs a <code>Dir.chdir</code> into the created
49  *   directory and yields to the block:
50  *
51  *   @example
52  *      # this:            # is a shorthand for:
53  *      Dir.mkdtemp do     #   dir = Dir.mkdtemp
54  *        puts Dir.pwd     #   Dir.chdir dir do
55  *      end                #     puts Dir.pwd
56  *                         #   end
57  *
58  *   @yield an optional block to perform operations inside the created directory.
59  *   @param [String, nil] template a template describing the desired form of the
60  *      directory name. If no template is supplied then "/tmp/temp.XXXXXX" is used
61  *      as a default.
62  *   @return [String] the path to the created directory
63  *   @raise [TypeError] if <code>template</code> is not a String or cannot be
64  *      converted into one
65  *   @raise [SecurityError] if <code>template</code> is tainted and
66  *      <code>$SAFE</code> is > 0
67  *   @raise [NoMemoryError] if temporary storage for the template could not be
68  *      allocated
69  *   @raise [SystemCallError] if the call to <code>mkdtemp()</code> fails
70  *
71  * @note
72  *   Note that the exact implementation of <code>mkdtemp()</code> may vary
73  *   depending on the target system. For example, on Mac OS X at the time of
74  *   writing, the man page states that the template may contain "some number" of
75  *   "Xs" on the end of the string, whereas on Red Hat Enterprise Linux it states
76  *   that the template suffix "must be XXXXXX".
77  */
78 static VALUE dir_mkdtemp_m(int argc, VALUE *argv, VALUE self)
79 {
80     VALUE template, block;
81     char *c_template;
82     char *path;
83
84     // process arguments
85     if (rb_scan_args(argc, argv, "01&", &template, &block) == 0)    // 0 mandatory, 1 optional, 1 block
86         template = Qnil;                                            // default to nil if no argument passed
87     if (NIL_P(template))
88         template = rb_str_new2("/tmp/temp.XXXXXX");                 // fallback to this template if passed nil
89     SafeStringValue(template);                                      // raises if template is tainted and SAFE level > 0
90     template = StringValue(template);                               // duck typing support
91
92     // create temporary storage
93     c_template = malloc(RSTRING_LEN(template) + 1);
94     if (!c_template)
95         rb_raise(rb_eNoMemError, "failed to allocate %ld bytes of template storage", RSTRING_LEN(template) + 1);
96     strncpy(c_template, RSTRING_PTR(template), RSTRING_LEN(template));
97     c_template[RSTRING_LEN(template)] = 0;              // NUL-terminate
98
99     // fill out template
100     path = mkdtemp(c_template);
101     if (path)
102         template = rb_str_new2(path);
103     free(c_template);
104     if (path == NULL)
105         rb_raise(rb_eSystemCallError, "mkdtemp failed (error #%d: %s)", errno, strerror(errno));
106
107     // yield to block if given, inside Dir.chdir
108     if (rb_block_given_p() == Qtrue)
109         rb_iterate(call_chdir, template, yield_block, block);
110     return template;
111 }
112
113 void Init_mkdtemp()
114 {
115 #if 0
116     // for YARD, need to fake this here
117     VALUE rb_cDir = rb_define_class("Dir", rb_cObject);
118 #endif
119     rb_define_singleton_method(rb_cDir, "mkdtemp", dir_mkdtemp_m, -1);
120 }