# common/manifests/defines/modules_dir.pp -- create a default directory
# for storing module specific information
#
# Copyright (C) 2007 David Schmitt <david@schmitt.edv-bus.at>
# See LICENSE for the full license granted to you.

# A module_dir is a storage place for all the stuff a module might want to
# store. According to the FHS, this should go to /var/lib. Since this is a part
# of puppet, the full path is /var/lib/puppet/modules/${name}. Every module
# should # prefix its module_dirs with its name.
# 
# By default, the module_dir is loaded from "puppet:///${name}/module_dir". If
# that doesn't exist an empty directory is taken as source. The directory is
# purged so that modules do not have to worry about removing cruft.
# 
# Usage:
# include common::moduledir
# module_dir { ["common", "common/dir1", "common/dir2" ]: }
#
# You may refer to a file in module_dir by using :
# file { "${common::moduledir::module_dir_path}/somedir/somefile": }

define module_dir (
        $mode = 0644, $owner = root, $group = 0
    )
{
    include common::moduledir
    $dir = "${common::moduledir::module_dir_path}/${name}"
    if defined(File[$dir]) {
        debug("${dir} already defined")
    } else {
        file {
            $dir:
                checksum => mtime,
                # ignore the placeholder
                recurse => true, purge => true, force => true,
                mode => $mode, owner => $owner, group => $group;
        }
    }
}

# alias for compatibility
define modules_dir (
        $mode = 0644, $owner = root, $group = 0
    )
{
  module_dir { $name: mode => $mode, owner => $owner, group => $group }
}