shelldap
author Mahlon E. Smith <mahlon@laika.com>
Fri, 15 Mar 2013 10:02:19 -0700
changeset 49 57df728cdb77
parent 48 fe27dfe5179e
child 50 21ba5eb5c2fc
permissions -rwxr-xr-x
Alter the default wrap width for LDIF to expand to the terminal size, with an optional rc file override.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
     1
#!/usr/bin/env perl
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
     2
# vim: set nosta noet ts=4 sw=4:
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
     3
#
42
b8c6d4e8f828 Add a flag to force a password prompt, so you can override credentials
Mahlon E. Smith <mahlon@laika.com>
parents: 41
diff changeset
     4
# Copyright (c) 2006-2012, Mahlon E. Smith <mahlon@martini.nu>
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
     5
# All rights reserved.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
     6
# Redistribution and use in source and binary forms, with or without
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
     7
# modification, are permitted provided that the following conditions are met:
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
     8
#
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
     9
#     * Redistributions of source code must retain the above copyright
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    10
#       notice, this list of conditions and the following disclaimer.
6
46dfe9d6f368 Update documentation, now that multiline edits work. Minor other
Mahlon E. Smith <mahlon@laika.com>
parents: 5
diff changeset
    11
#
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    12
#     * Redistributions in binary form must reproduce the above copyright
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    13
#       notice, this list of conditions and the following disclaimer in the
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    14
#       documentation and/or other materials provided with the distribution.
6
46dfe9d6f368 Update documentation, now that multiline edits work. Minor other
Mahlon E. Smith <mahlon@laika.com>
parents: 5
diff changeset
    15
#
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    16
#     * Neither the name of Mahlon E. Smith nor the names of his
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    17
#       contributors may be used to endorse or promote products derived
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    18
#       from this software without specific prior written permission.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    19
#
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    20
# THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    21
# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    22
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    23
# DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    24
# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    25
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    26
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    27
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    28
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    29
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    30
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    31
=head1 NAME
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    32
10
664bbe3dcd44 Follow regular man page conventions. Patch from
Mahlon E. Smith <mahlon@laika.com>
parents: 9
diff changeset
    33
Shelldap - A program for interacting with an LDAP server via a shell-like interface
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    34
10
664bbe3dcd44 Follow regular man page conventions. Patch from
Mahlon E. Smith <mahlon@laika.com>
parents: 9
diff changeset
    35
=head1 DESCRIPTION
664bbe3dcd44 Follow regular man page conventions. Patch from
Mahlon E. Smith <mahlon@laika.com>
parents: 9
diff changeset
    36
664bbe3dcd44 Follow regular man page conventions. Patch from
Mahlon E. Smith <mahlon@laika.com>
parents: 9
diff changeset
    37
Shelldap /LDAP::Shell is a program for interacting with an LDAP server via a shell-like
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    38
interface.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    39
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    40
This is not meant to be an exhaustive LDAP editing and browsing
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    41
interface, but rather an intuitive shell for performing basic LDAP
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    42
tasks quickly and with minimal effort.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    43
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    44
=head1 SYNPOSIS
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    45
3
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
    46
 shelldap --server example.net [--help]
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    47
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    48
=head1 FEATURES
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    49
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    50
 - Upon successful authenticated binding, credential information is
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    51
   auto-cached to ~/.shelldap.rc -- future loads require no command line
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    52
   flags.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    53
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    54
 - Custom 'description maps' for entry listings.  (See the 'list' command.)
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    55
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    56
 - History and autocomplete via readline, if installed.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    57
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    58
 - Automatic reconnection attempts if the connection is lost with the
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    59
   LDAP server.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    60
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    61
 - It feels like a semi-crippled shell, making LDAP browsing and editing
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    62
   at least halfway pleasurable.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    63
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    64
=head1 OPTIONS
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    65
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    66
All command line options follow getopts long conventions.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    67
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    68
    shelldap --server example.net --basedn dc=your,o=company
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    69
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    70
You may also optionally create a ~/.shelldap.rc file with command line
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    71
defaults.  This file should be valid YAML.  (This file is generated
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    72
automatically on a successful bind auth.)
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    73
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    74
Example:
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    75
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    76
    server: ldap.example.net
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    77
    binddn: cn=Manager,dc=your,o=company
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    78
    bindpass: xxxxxxxxx
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    79
    basedn: dc=your,o=company
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    80
    tls: yes
3
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
    81
    tls_cacert: /etc/ssl/certs/cacert.pem
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
    82
    tls_cert:   ~/.ssl/client.cert.pem 
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
    83
    tls_key:    ~/.ssl/private/client.key.pem
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    84
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    85
=over 4
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    86
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    87
=item B<server>
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    88
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    89
Required. The LDAP server to connect to.  This can be a hostname, IP
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    90
address, or a URI.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    91
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    92
    --server ldaps://ldap.example.net
19
18e71da965ff Add documentation for the additional short flags.
Mahlon E. Smith <mahlon@martini.nu>
parents: 18
diff changeset
    93
    -H ldaps://ldap.example.net
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    94
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    95
=back
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    96
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    97
=over 4
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    98
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
    99
=item B<binddn>
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   100
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   101
The full dn of a user to authenticate as.  If not specified, defaults to
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   102
an anonymous bind.  You will be prompted for a password.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   103
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   104
    --binddn cn=Manager,dc=your,o=company
19
18e71da965ff Add documentation for the additional short flags.
Mahlon E. Smith <mahlon@martini.nu>
parents: 18
diff changeset
   105
    -D cn=Manager,dc=your,o=company
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   106
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   107
=back
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   108
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   109
=over 4
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   110
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   111
=item B<basedn>
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   112
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   113
The directory 'root' of your LDAP server.  If omitted, shelldap will
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   114
try and ask the server for a sane default.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   115
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   116
    --basedn dc=your,o=company
19
18e71da965ff Add documentation for the additional short flags.
Mahlon E. Smith <mahlon@martini.nu>
parents: 18
diff changeset
   117
    -b dc=your,o=company
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   118
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   119
=back
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   120
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   121
=over 4
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   122
42
b8c6d4e8f828 Add a flag to force a password prompt, so you can override credentials
Mahlon E. Smith <mahlon@laika.com>
parents: 41
diff changeset
   123
=item B<promptpass>
b8c6d4e8f828 Add a flag to force a password prompt, so you can override credentials
Mahlon E. Smith <mahlon@laika.com>
parents: 41
diff changeset
   124
b8c6d4e8f828 Add a flag to force a password prompt, so you can override credentials
Mahlon E. Smith <mahlon@laika.com>
parents: 41
diff changeset
   125
Force password prompting.  Useful to temporarily override cached
b8c6d4e8f828 Add a flag to force a password prompt, so you can override credentials
Mahlon E. Smith <mahlon@laika.com>
parents: 41
diff changeset
   126
credentials.
b8c6d4e8f828 Add a flag to force a password prompt, so you can override credentials
Mahlon E. Smith <mahlon@laika.com>
parents: 41
diff changeset
   127
b8c6d4e8f828 Add a flag to force a password prompt, so you can override credentials
Mahlon E. Smith <mahlon@laika.com>
parents: 41
diff changeset
   128
=back
b8c6d4e8f828 Add a flag to force a password prompt, so you can override credentials
Mahlon E. Smith <mahlon@laika.com>
parents: 41
diff changeset
   129
b8c6d4e8f828 Add a flag to force a password prompt, so you can override credentials
Mahlon E. Smith <mahlon@laika.com>
parents: 41
diff changeset
   130
=over 4
b8c6d4e8f828 Add a flag to force a password prompt, so you can override credentials
Mahlon E. Smith <mahlon@laika.com>
parents: 41
diff changeset
   131
b8c6d4e8f828 Add a flag to force a password prompt, so you can override credentials
Mahlon E. Smith <mahlon@laika.com>
parents: 41
diff changeset
   132
=item B<tls>
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   133
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   134
Enables TLS over what would normally be an insecure connection.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   135
Requires server side support.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   136
3
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   137
=item B<tls_cacert>
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   138
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   139
Specify CA Certificate to trust.
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   140
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   141
    --tls_cacert /etc/ssl/certs/cacert.pem
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   142
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   143
=item B<tls_cert>
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   144
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   145
The TLS client certificate.
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   146
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   147
    --tls_cert ~/.ssl/client.cert.pem
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   148
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   149
=item B<tls_key>
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   150
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   151
The TLS client key.  Not specifying a key will connect via TLS without
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   152
key verification.
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   153
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   154
    --tls_key ~/.ssl/private/client.key.pem
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   155
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   156
=back
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   157
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   158
=over 4
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   159
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   160
=item B<cacheage>
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   161
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   162
Set the time to cache directory lookups in seconds.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   163
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   164
By default, directory lookups are cached for 300 seconds, to speed
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   165
autocomplete up when changing between different basedns.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   166
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   167
Modifications to the directory automatically reset the cache.  Directory
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   168
listings are not cached.  (This is just used for autocomplete.)  Set it
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   169
to 0 to disable caching completely.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   170
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   171
=back
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   172
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   173
=over 4
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   174
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   175
=item B<timeout>
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   176
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   177
Set the maximum time an LDAP operation can take before it is cancelled.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   178
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   179
=back
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   180
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   181
=over 4
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   182
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   183
=item B<debug>
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   184
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   185
Print extra operational info out, and backtrace on fatal error.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   186
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   187
=back
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   188
37
7a8855e7cfb8 Add a --version flag.
Mahlon E. Smith <mahlon@martini.nu>
parents: 36
diff changeset
   189
=over 4
7a8855e7cfb8 Add a --version flag.
Mahlon E. Smith <mahlon@martini.nu>
parents: 36
diff changeset
   190
7a8855e7cfb8 Add a --version flag.
Mahlon E. Smith <mahlon@martini.nu>
parents: 36
diff changeset
   191
=item B<version>
7a8855e7cfb8 Add a --version flag.
Mahlon E. Smith <mahlon@martini.nu>
parents: 36
diff changeset
   192
7a8855e7cfb8 Add a --version flag.
Mahlon E. Smith <mahlon@martini.nu>
parents: 36
diff changeset
   193
Display the version number.
7a8855e7cfb8 Add a --version flag.
Mahlon E. Smith <mahlon@martini.nu>
parents: 36
diff changeset
   194
7a8855e7cfb8 Add a --version flag.
Mahlon E. Smith <mahlon@martini.nu>
parents: 36
diff changeset
   195
=back
7a8855e7cfb8 Add a --version flag.
Mahlon E. Smith <mahlon@martini.nu>
parents: 36
diff changeset
   196
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   197
=head1 SHELL COMMANDS
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   198
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   199
=over 4
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   200
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   201
=item B< cat>
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   202
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   203
Display an LDIF dump of an entry.  Globbing is supported.  Specify
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   204
either the full dn, or an rdn.  For most commands, rdns are local to the
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   205
current search base. ('cwd', as translated to shell speak.)  You may additionally
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   206
add a list of attributes to display.  Use '+' for server side attributes.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   207
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   208
    cat uid=mahlon
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   209
    cat ou=*
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   210
    cat uid=mahlon,ou=People,dc=example,o=company
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   211
    cat uid=mahlon + userPassword
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   212
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   213
=item B<  cd>
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   214
33
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   215
Change directory.  Translated to LDAP, this changes the current basedn.
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   216
All commands after a 'cd' operate within the new basedn.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   217
33
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   218
    cd                  change to 'home' basedn
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   219
    cd ~                change to the binddn, or basedn if anonymously bound
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   220
    cd -                change to previous node
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   221
    cd ou=People        change to explicit path below current node
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   222
    cd ..               change to parent node
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   223
    cd ../../ou=Groups  change to node ou=Groups, which is a sibling
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   224
                        to the current node's grandparent
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   225
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   226
Since LDAP doesn't actually limit what can be a container object, you
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   227
can actually cd into any entry. Many commands then work on '.', meaning
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   228
"wherever I currently am."
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   229
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   230
    cd uid=mahlon
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   231
    cat .
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   232
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   233
=item B<clear>
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   234
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   235
Clear the screen.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   236
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   237
=item B<copy>
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   238
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   239
Copy an entry to a different dn path.  All copies are relative to the
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   240
current basedn, unless a full dn is specified.  All attributes are
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   241
copied, then an LDAP moddn() is performed.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   242
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   243
    copy uid=mahlon uid=bob
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   244
    copy uid=mahlon ou=Others,dc=example,o=company
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   245
    copy uid=mahlon,ou=People,dc=example,o=company uid=mahlon,ou=Others,dc=example,o=company
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   246
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   247
aliased to: cp
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   248
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   249
=item B<create>
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   250
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   251
Create an entry from scratch.  Arguments are space separated objectClass
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   252
names.  Possible objectClasses are derived automatically from the
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   253
server, and will tab-complete.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   254
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   255
After the classes are specified, an editor will launch.  Required
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   256
attributes are listed first, then optional attributes.  Optionals are
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   257
commented out.  After the editor exits, the resulting LDIF is validated
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   258
and added to the LDAP directory.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   259
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   260
    create top person organizationalPerson inetOrgPerson posixAccount
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   261
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   262
aliased to: touch
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   263
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   264
=item B<delete>
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   265
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   266
Remove an entry from the directory.  Globbing is supported.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   267
All deletes are sanity-prompted.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   268
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   269
    delete uid=mahlon
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   270
    delete uid=ma*
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   271
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   272
aliased to: rm
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   273
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   274
=item B<edit>
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   275
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   276
Edit an entry in an external editor.  After the editor exits, the
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   277
resulting LDIF is sanity checked, and changes are written to the LDAP
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   278
directory.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   279
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   280
    edit uid=mahlon
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   281
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   282
aliased to: vi
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   283
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   284
=item B< env>
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   285
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   286
 Show values for various runtime variables.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   287
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   288
=item B<grep>
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   289
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   290
Search for arbitrary LDAP filters, and return matching dn results.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   291
The search string must be a valid LDAP filter.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   292
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   293
    grep uid=mahlon
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   294
    grep uid=mahlon ou=People
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   295
    grep -r (&(uid=mahlon)(objectClass=*))
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   296
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   297
 aliased to: search
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   298
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   299
=item B<list>
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   300
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   301
List entries for the current basedn.  Globbing is supported.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   302
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   303
aliased to: ls
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   304
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   305
    ls -l
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   306
    ls -lR uid=mahlon
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   307
    list uid=m*
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   308
36
2e78218b8045 Small documentation fixes, add better verbosity when saving connection
Mahlon E. Smith <mahlon@martini.nu>
parents: 35
diff changeset
   309
In 'long' mode, descriptions are listed as well, if they exist.
2e78218b8045 Small documentation fixes, add better verbosity when saving connection
Mahlon E. Smith <mahlon@martini.nu>
parents: 35
diff changeset
   310
There are some default 'long listing' mappings for common objectClass
2e78218b8045 Small documentation fixes, add better verbosity when saving connection
Mahlon E. Smith <mahlon@martini.nu>
parents: 35
diff changeset
   311
types.  You can additionally specify your own mappings in your
2e78218b8045 Small documentation fixes, add better verbosity when saving connection
Mahlon E. Smith <mahlon@martini.nu>
parents: 35
diff changeset
   312
.shelldap.rc, like so:
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   313
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   314
    ...
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   315
    descmaps:
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   316
        objectClass: attributename
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   317
        posixAccount: gecos
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   318
        posixGroup: gidNumber
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   319
        ipHost: ipHostNumber
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   320
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   321
=item B<mkdir>
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   322
38
12f279ef4f9d Backout the additional objectClasses patch for mkdir: same behavior can
Mahlon E. Smith <mahlon@martini.nu>
parents: 37
diff changeset
   323
Creates a new 'organizationalUnit' entry.
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   324
38
12f279ef4f9d Backout the additional objectClasses patch for mkdir: same behavior can
Mahlon E. Smith <mahlon@martini.nu>
parents: 37
diff changeset
   325
    mkdir containername
12f279ef4f9d Backout the additional objectClasses patch for mkdir: same behavior can
Mahlon E. Smith <mahlon@martini.nu>
parents: 37
diff changeset
   326
    mkdir ou=whatever
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   327
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   328
=item B<move>
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   329
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   330
Move an entry to a different dn path.  Usage is identical to B<copy>.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   331
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   332
aliased to: mv
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   333
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   334
=item B<passwd>
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   335
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   336
If supported server side, change the password for a specified entry.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   337
The entry must have a 'userPassword' attribute.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   338
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   339
    passwd uid=mahlon
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   340
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   341
=item B< pwd>
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   342
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   343
Print the 'working directory' - aka, the current ldap basedn.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   344
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   345
=item B<setenv>
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   346
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   347
Modify various runtime variables normally set from the command line.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   348
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   349
    setenv debug 1
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   350
    export debug=1
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   351
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   352
=item B<whoami>
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   353
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   354
Show current auth credentials.  Unless you specified a binddn, this
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   355
will just show an anonymous bind.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   356
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   357
=back
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   358
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   359
=head1 TODO
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   360
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   361
Referral support.  Currently, if you try to write to a replicant slave,
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   362
you'll just get a referral.  It would be nice if shelldap automatically
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   363
tried to follow it.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   364
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   365
For now, it only makes sense to connect to a master if you plan on doing
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   366
any writes.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   367
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   368
=head1 BUGS / LIMITATIONS
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   369
6
46dfe9d6f368 Update documentation, now that multiline edits work. Minor other
Mahlon E. Smith <mahlon@laika.com>
parents: 5
diff changeset
   370
There is no support for editing binary data.  If you need to edit base64
46dfe9d6f368 Update documentation, now that multiline edits work. Minor other
Mahlon E. Smith <mahlon@laika.com>
parents: 5
diff changeset
   371
stuff, just feed it to the regular ldapmodify/ldapadd/etc tools.
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   372
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   373
=head1 AUTHOR
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   374
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   375
Mahlon E. Smith <mahlon@martini.nu>
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   376
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   377
=cut
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   378
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   379
package LDAP::Shell;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   380
use strict;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   381
use warnings;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   382
use Term::ReadKey;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   383
use Term::Shell;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   384
use Digest::MD5;
48
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   385
use Net::LDAP qw/
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   386
	LDAP_SUCCESS
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   387
	LDAP_SERVER_DOWN
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   388
	LDAP_OPERATIONS_ERROR
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   389
	LDAP_TIMELIMIT_EXCEEDED
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   390
	LDAP_BUSY
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   391
	LDAP_UNAVAILABLE
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   392
	LDAP_OTHER
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   393
	LDAP_TIMEOUT
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   394
	LDAP_NO_MEMORY
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   395
	LDAP_CONNECT_ERROR /;
33
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   396
use Net::LDAP::Util qw/ canonical_dn ldap_explode_dn /;
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   397
use Net::LDAP::LDIF;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   398
use Data::Dumper;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   399
use File::Temp;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   400
use Algorithm::Diff;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   401
use Carp 'confess';
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   402
use base 'Term::Shell';
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   403
require Net::LDAP::Extension::SetPassword;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   404
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   405
my $conf = $main::conf;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   406
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   407
# make 'die' backtrace in debug mode
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   408
$SIG{'__DIE__'} = \&Carp::confess if $conf->{'debug'};
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   409
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   410
###############################################################
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   411
#
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   412
# UTILITY FUNCTIONS
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   413
#
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   414
###############################################################
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   415
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   416
# initial shell behaviors
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   417
# 
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   418
sub init
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   419
{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   420
	my $self = shift;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   421
	$self->{'API'}->{'match_uniq'} = 0;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   422
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   423
	$self->{'editor'} = $ENV{'EDITOR'} || 'vi';
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   424
	$self->{'env'}	= [ qw/ debug cacheage timeout / ];
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   425
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   426
	# let autocomplete work with the '=' character
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   427
	my $term = $self->term();
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   428
	$term->Attribs->{'basic_word_break_characters'}	 =~ s/=//m;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   429
	$term->Attribs->{'completer_word_break_characters'} =~ s/=//m;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   430
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   431
	# read in history
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   432
	eval {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   433
		$term->history_truncate_file("$ENV{'HOME'}/.shelldap_history", 50);
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   434
		$term->ReadHistory("$ENV{'HOME'}/.shelldap_history");
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   435
	};
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   436
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   437
	$self->{'root_dse'} = $self->ldap->root_dse();
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   438
	if ( $conf->{'debug'} ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   439
		$self->{'schema'}   = $self->ldap->schema();
17
669085d93aa3 simplify over-complex call of N:L:E->get_value()
Peter Marschall <peter@adpm.de>
parents: 16
diff changeset
   440
		my @versions = $self->{'root_dse'}->get_value('supportedLDAPVersion');
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   441
		print "Connected to $conf->{'server'}\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   442
		print "Supported LDAP version: ", ( join ', ', @versions ), "\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   443
		print "Cipher in use: ", $self->ldap()->cipher(), "\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   444
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   445
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   446
	# try an initial search and die if it doesn't work
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   447
	# (bad baseDN)
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   448
	my $s = $self->search();
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   449
	die "LDAP baseDN error: ", $s->{'message'}, "\n" if $s->{'code'};
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   450
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   451
	$self->{'schema'} = $self->ldap->schema();
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   452
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   453
	# okay, now do an initial population of 'cwd'
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   454
	# for autocomplete.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   455
	$self->update_entries();
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   456
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   457
	# whew, okay.  Update prompt, wait for input!
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   458
	$self->update_prompt();
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   459
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   460
	return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   461
}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   462
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   463
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   464
# get an ldap connection handle
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   465
#
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   466
sub ldap
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   467
{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   468
	my $self = shift;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   469
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   470
	# use cached connection object if it exists
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   471
	return $self->{'ldap'} if $self->{'ldap'};
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   472
	
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   473
	# fill in potentially missing info
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   474
	die "No server specified.\n" unless $conf->{'server'};
15
f6157d378459 Exit with a nicer error message if IO::Socket::SSL isn't installed,
Mahlon E. Smith <mahlon@martini.nu>
parents: 14
diff changeset
   475
f6157d378459 Exit with a nicer error message if IO::Socket::SSL isn't installed,
Mahlon E. Smith <mahlon@martini.nu>
parents: 14
diff changeset
   476
	# Emit a nicer error message if IO::Socket::SSL is
f6157d378459 Exit with a nicer error message if IO::Socket::SSL isn't installed,
Mahlon E. Smith <mahlon@martini.nu>
parents: 14
diff changeset
   477
	# not installed and Net::LDAP decides it is required.
f6157d378459 Exit with a nicer error message if IO::Socket::SSL isn't installed,
Mahlon E. Smith <mahlon@martini.nu>
parents: 14
diff changeset
   478
	#
f6157d378459 Exit with a nicer error message if IO::Socket::SSL isn't installed,
Mahlon E. Smith <mahlon@martini.nu>
parents: 14
diff changeset
   479
	if ( $conf->{'tls'} || $conf->{'server'} =~ m|ldaps://| ) {
f6157d378459 Exit with a nicer error message if IO::Socket::SSL isn't installed,
Mahlon E. Smith <mahlon@martini.nu>
parents: 14
diff changeset
   480
		eval 'use IO::Socket::SSL';
f6157d378459 Exit with a nicer error message if IO::Socket::SSL isn't installed,
Mahlon E. Smith <mahlon@martini.nu>
parents: 14
diff changeset
   481
		die qq{IO::Socket::SSL not installed, but is required for SSL or TLS connections.
f6157d378459 Exit with a nicer error message if IO::Socket::SSL isn't installed,
Mahlon E. Smith <mahlon@martini.nu>
parents: 14
diff changeset
   482
You may try connecting insecurely, or install the module and try again.\n} if $@;
f6157d378459 Exit with a nicer error message if IO::Socket::SSL isn't installed,
Mahlon E. Smith <mahlon@martini.nu>
parents: 14
diff changeset
   483
	}
f6157d378459 Exit with a nicer error message if IO::Socket::SSL isn't installed,
Mahlon E. Smith <mahlon@martini.nu>
parents: 14
diff changeset
   484
42
b8c6d4e8f828 Add a flag to force a password prompt, so you can override credentials
Mahlon E. Smith <mahlon@laika.com>
parents: 41
diff changeset
   485
	if ( ($conf->{'binddn'} && ! $conf->{'bindpass'}) || $conf->{'promptpass'} ) {
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   486
		print "Bind password: ";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   487
		Term::ReadKey::ReadMode 2;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   488
		chomp($conf->{'bindpass'} = <STDIN>);
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   489
		Term::ReadKey::ReadMode 0;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   490
		print "\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   491
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   492
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   493
	# make connection
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   494
	my $ldap = Net::LDAP->new( $conf->{'server'} )
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   495
		or die "Unable to connect to LDAP server '$conf->{'server'}': $!\n";
3
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   496
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   497
	# secure connection options
15
f6157d378459 Exit with a nicer error message if IO::Socket::SSL isn't installed,
Mahlon E. Smith <mahlon@martini.nu>
parents: 14
diff changeset
   498
	#
f6157d378459 Exit with a nicer error message if IO::Socket::SSL isn't installed,
Mahlon E. Smith <mahlon@martini.nu>
parents: 14
diff changeset
   499
	if ( $conf->{'tls'} )  {
3
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   500
		if ( $conf->{'tls_key'} ) {
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   501
			$ldap->start_tls( 
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   502
				verify     => 'require',
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   503
				cafile     => $conf->{'tls_cacert'},
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   504
				clientcert => $conf->{'tls_cert'},
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   505
				clientkey  => $conf->{'tls_key'},
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   506
				keydecrypt => sub {
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   507
					print "Key Passphrase: "; 
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   508
					Term::ReadKey::ReadMode 2;
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   509
					chomp(my $secret = <STDIN>);
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   510
					Term::ReadKey::ReadMode 0;
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   511
					print "\n";
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   512
					return $secret;
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   513
				});
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   514
		}
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   515
		else {
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   516
			$ldap->start_tls( verify => 'none' );
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   517
		}
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   518
	}
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   519
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   520
	# bind
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   521
	my $rv;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   522
	if ( $conf->{'binddn'} ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   523
		# authed
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   524
		$rv = $ldap->bind(
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   525
			$conf->{'binddn'},
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   526
			password => $conf->{'bindpass'}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   527
		);
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   528
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   529
	else {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   530
		# anon
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   531
		$rv = $ldap->bind();
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   532
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   533
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   534
	my $err = $rv->error();
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   535
	if ( $rv->code() ) {
15
f6157d378459 Exit with a nicer error message if IO::Socket::SSL isn't installed,
Mahlon E. Smith <mahlon@martini.nu>
parents: 14
diff changeset
   536
		$err .= " (try the --tls flag?)"
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   537
			if $err =~ /confidentiality required/i;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   538
		die "LDAP bind error: $err\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   539
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   540
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   541
	# offer to cache authentication info
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   542
	# if we enter this conditional, we have successfully 
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   543
	# authed with the server (non anonymous), and 
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   544
	# we haven't cached anything in the past.
15
f6157d378459 Exit with a nicer error message if IO::Socket::SSL isn't installed,
Mahlon E. Smith <mahlon@martini.nu>
parents: 14
diff changeset
   545
	#
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   546
	if ( $conf->{'binddn'} && ! -e $conf->{'confpath'} ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   547
		print "Would you like to cache your connection information? [Y/n]: ";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   548
		chomp( my $response = <STDIN> );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   549
		unless ( $response =~ /^n/i ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   550
			YAML::Syck::DumpFile( $conf->{'confpath'}, $conf );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   551
			chmod 0600, $conf->{'confpath'};
36
2e78218b8045 Small documentation fixes, add better verbosity when saving connection
Mahlon E. Smith <mahlon@martini.nu>
parents: 35
diff changeset
   552
			print "Connection info cached to $conf->{'confpath'}.\n";
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   553
		}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   554
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   555
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   556
	$self->{'ldap'} = $ldap;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   557
	return $ldap;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   558
}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   559
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   560
# just return an LDIF object
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   561
#
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   562
sub ldif 
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   563
{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   564
	my $self	 = shift;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   565
	my $use_temp = shift;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   566
49
57df728cdb77 Alter the default wrap width for LDIF to expand to the terminal size,
Mahlon E. Smith <mahlon@laika.com>
parents: 48
diff changeset
   567
	# find the terminal width
57df728cdb77 Alter the default wrap width for LDIF to expand to the terminal size,
Mahlon E. Smith <mahlon@laika.com>
parents: 48
diff changeset
   568
	#
57df728cdb77 Alter the default wrap width for LDIF to expand to the terminal size,
Mahlon E. Smith <mahlon@laika.com>
parents: 48
diff changeset
   569
	my $wrap = $conf->{'wrap'};
57df728cdb77 Alter the default wrap width for LDIF to expand to the terminal size,
Mahlon E. Smith <mahlon@laika.com>
parents: 48
diff changeset
   570
	eval {
57df728cdb77 Alter the default wrap width for LDIF to expand to the terminal size,
Mahlon E. Smith <mahlon@laika.com>
parents: 48
diff changeset
   571
		my $rows;
57df728cdb77 Alter the default wrap width for LDIF to expand to the terminal size,
Mahlon E. Smith <mahlon@laika.com>
parents: 48
diff changeset
   572
		my $term = Term::ReadLine->new( 1 );
57df728cdb77 Alter the default wrap width for LDIF to expand to the terminal size,
Mahlon E. Smith <mahlon@laika.com>
parents: 48
diff changeset
   573
		( $rows, $wrap ) = $term->get_screen_size() unless $wrap;
57df728cdb77 Alter the default wrap width for LDIF to expand to the terminal size,
Mahlon E. Smith <mahlon@laika.com>
parents: 48
diff changeset
   574
	};
57df728cdb77 Alter the default wrap width for LDIF to expand to the terminal size,
Mahlon E. Smith <mahlon@laika.com>
parents: 48
diff changeset
   575
	$wrap ||= 78;
57df728cdb77 Alter the default wrap width for LDIF to expand to the terminal size,
Mahlon E. Smith <mahlon@laika.com>
parents: 48
diff changeset
   576
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   577
	# create tmpfile and link ldif object with it
49
57df728cdb77 Alter the default wrap width for LDIF to expand to the terminal size,
Mahlon E. Smith <mahlon@laika.com>
parents: 48
diff changeset
   578
	#
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   579
	if ( $use_temp ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   580
		my ( undef, $fname ) =
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   581
		  File::Temp::tempfile( 'shelldap_XXXXXXXX', DIR => '/tmp', UNLINK => 1 );
49
57df728cdb77 Alter the default wrap width for LDIF to expand to the terminal size,
Mahlon E. Smith <mahlon@laika.com>
parents: 48
diff changeset
   582
		$self->{'ldif'}	      = Net::LDAP::LDIF->new( $fname, 'w', sort => 1, wrap => $wrap );
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   583
		$self->{'ldif_fname'} = $fname;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   584
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   585
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   586
	# ldif -> stdout
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   587
	else {
49
57df728cdb77 Alter the default wrap width for LDIF to expand to the terminal size,
Mahlon E. Smith <mahlon@laika.com>
parents: 48
diff changeset
   588
		$self->{'ldif'} = Net::LDAP::LDIF->new( \*STDOUT, 'w', sort => 1, wrap => $wrap );
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   589
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   590
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   591
	return $self->{'ldif'};
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   592
}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   593
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   594
# load and return an Entry object from LDIF
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   595
#
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   596
sub load_ldif
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   597
{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   598
	my $self = shift;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   599
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   600
	my $ldif =  Net::LDAP::LDIF->new( shift(), 'r' );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   601
	return unless $ldif;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   602
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   603
	my $e;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   604
	eval { $e = $ldif->read_entry(); };
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   605
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   606
	return if $@;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   607
	return $e;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   608
}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   609
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   610
# given a filename, return an md5 checksum
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   611
#
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   612
sub chksum 
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   613
{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   614
	my $self = shift;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   615
	my $file = shift or return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   616
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   617
	my $md5 = Digest::MD5->new();
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   618
	open F, $file or die "Unable to read temporary ldif: $!\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   619
	my $hash = $md5->addfile( *F )->hexdigest();
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   620
	close F;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   621
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   622
	return $hash;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   623
}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   624
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   625
# prompt functions
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   626
#
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   627
sub prompt_str
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   628
{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   629
	my $self = shift;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   630
	return $self->{'prompt'};
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   631
}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   632
sub update_prompt 
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   633
{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   634
	my $self = shift;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   635
	my $base = $self->base();
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   636
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   637
	if ( length $base > 50 ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   638
		my $cwd_dn = $1 if $base =~ /^(.*?),/;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   639
		$self->{'prompt'} = "... $cwd_dn > ";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   640
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   641
	else {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   642
		my $prompt = $base;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   643
		$prompt =~ s/$conf->{'basedn'}/~/;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   644
		$self->{'prompt'} = "$prompt > ";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   645
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   646
	return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   647
}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   648
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   649
# search base accessor
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   650
#
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   651
sub base 
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   652
{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   653
	my $self = shift;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   654
	$self->{'base'} ||= $conf->{'basedn'};
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   655
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   656
	# try and determine base automatically from rootDSE
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   657
	#
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   658
	unless ( $self->{'base'} ) {
20
d956658803b8 use sane way to get a default basedn: RootDSe's namingContexts
Peter Marschall <peter@adpm.de>
parents: 19
diff changeset
   659
		my @namingContexts = $self->{'root_dse'}->get_value('namingContexts');
d956658803b8 use sane way to get a default basedn: RootDSe's namingContexts
Peter Marschall <peter@adpm.de>
parents: 19
diff changeset
   660
		$conf->{'basedn'} = $namingContexts[0];
d956658803b8 use sane way to get a default basedn: RootDSe's namingContexts
Peter Marschall <peter@adpm.de>
parents: 19
diff changeset
   661
		$self->{'base'}   = $namingContexts[0];
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   662
	}
23
2ab2df609cc7 small style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 22
diff changeset
   663
	if ( $_[0] ) {
2ab2df609cc7 small style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 22
diff changeset
   664
		my $base = canonical_dn( $_[0], casefold => 'none' );
2ab2df609cc7 small style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 22
diff changeset
   665
		$self->{'base'} = $base if $base;
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   666
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   667
	return $self->{'base'};
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   668
}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   669
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   670
# do a search on a dn to determine if it is valid.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   671
# returns a bool.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   672
#
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   673
sub is_valid_dn 
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   674
{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   675
	my $self = shift;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   676
	my $dn   = shift or return 0;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   677
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   678
	my $r = $self->search({ base => $dn });
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   679
16
a2e3faa3d2fc use symbolic LDAP error codes instead of numbers
Peter Marschall <peter@adpm.de>
parents: 15
diff changeset
   680
	return $r->{'code'} == LDAP_SUCCESS ? 1 : 0;
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   681
}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   682
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   683
# perform an ldap search
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   684
# return an hashref containing return code and
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   685
# arrayref of Net::LDAP::Entry objects
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   686
#
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   687
sub search 
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   688
{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   689
	my $self = shift;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   690
	my $opts = shift || {};
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   691
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   692
	$opts->{'base'}   ||= $self->base(),
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   693
	$opts->{'filter'} ||= '(objectClass=*)';
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   694
	$opts->{'scope'}  ||= 'base';
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   695
48
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   696
	my $search = sub { 
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   697
		return $self->ldap->search(
43
b8836c9018fb Attempt to retry the operation on failure.
Mahlon E. Smith <mahlon@laika.com>
parents: 42
diff changeset
   698
			base	  => $opts->{'base'},
b8836c9018fb Attempt to retry the operation on failure.
Mahlon E. Smith <mahlon@laika.com>
parents: 42
diff changeset
   699
			filter	  => $opts->{'filter'},
b8836c9018fb Attempt to retry the operation on failure.
Mahlon E. Smith <mahlon@laika.com>
parents: 42
diff changeset
   700
			scope	  => $opts->{'scope'},
b8836c9018fb Attempt to retry the operation on failure.
Mahlon E. Smith <mahlon@laika.com>
parents: 42
diff changeset
   701
			timelimit => $conf->{'timeout'},
b8836c9018fb Attempt to retry the operation on failure.
Mahlon E. Smith <mahlon@laika.com>
parents: 42
diff changeset
   702
			typesonly => ! $opts->{'vals'},
b8836c9018fb Attempt to retry the operation on failure.
Mahlon E. Smith <mahlon@laika.com>
parents: 42
diff changeset
   703
			attrs	  => $opts->{'attrs'} || ['*']
b8836c9018fb Attempt to retry the operation on failure.
Mahlon E. Smith <mahlon@laika.com>
parents: 42
diff changeset
   704
		);
48
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   705
	};
43
b8836c9018fb Attempt to retry the operation on failure.
Mahlon E. Smith <mahlon@laika.com>
parents: 42
diff changeset
   706
48
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   707
	my $s = $self->with_retry( $search );
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   708
	my $rv = {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   709
		code	  => $s->code(),
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   710
		message   => $s->error(),
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   711
		entries   => []
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   712
	};
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   713
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   714
	$rv->{'entries'} =
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   715
	  $opts->{'scope'} eq 'base' ? [ $s->shift_entry() ] : [ $s->entries() ];
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   716
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   717
	return $rv;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   718
}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   719
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   720
# update the autocomplete for entries
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   721
# in the current base tree, respecting or creating cache.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   722
#
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   723
sub update_entries 
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   724
{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   725
	my $self = shift;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   726
	my %opts = @_;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   727
	my $base = lc( $self->base() );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   728
	
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   729
	my $s = $opts{'search'} || $self->search({ scope => 'one' });
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   730
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   731
	$self->{'cwd_entries'} = [];
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   732
	return if $s->{'code'};
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   733
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   734
	# setup cache object
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   735
	$self->{'cache'} ||= {};
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   736
	$self->{'cache'}->{ $base } ||= {};
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   737
	$self->{'cache'}->{ $base } = {} if $opts{'clearcache'};
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   738
	my $cache = $self->{'cache'}->{ $base };
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   739
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   740
	my $now = time();
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   741
	if ( ! exists $cache->{'entries'}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   742
		or $now - $cache->{'timestamp'} > $conf->{'cacheage'} )
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   743
	{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   744
		$self->debug("Caching entries for $base\n");
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   745
		foreach my $e ( @{ $s->{'entries'} } ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   746
			my $dn  = $e->dn();
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   747
			my $rdn = $dn;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   748
			$rdn =~ s/,$base//i;  # remove base from display
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   749
			push @{ $self->{'cwd_entries'} }, $rdn;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   750
		}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   751
		$cache->{'timestamp'} = $now;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   752
		$cache->{'entries'} = $self->{'cwd_entries'};
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   753
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   754
	else {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   755
		$self->debug("Using cached lookups for $base\n");
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   756
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   757
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   758
	$self->{'cwd_entries'} = $cache->{'entries'};
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   759
	return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   760
}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   761
33
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   762
# convert a given path to a DN: deal with '..', '.'
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   763
# Synopsis: $dn = $self->path_to_dn( $path );
30
e4b4b0968107 add method path_to_dn() to convert a given "path" to a DN
Peter Marschall <peter@adpm.de>
parents: 29
diff changeset
   764
sub path_to_dn
e4b4b0968107 add method path_to_dn() to convert a given "path" to a DN
Peter Marschall <peter@adpm.de>
parents: 29
diff changeset
   765
{
33
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   766
	my $self    = shift;
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   767
	my $path    = shift;
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   768
	my %flags   = @_;
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   769
	my $curbase = $self->base();
30
e4b4b0968107 add method path_to_dn() to convert a given "path" to a DN
Peter Marschall <peter@adpm.de>
parents: 29
diff changeset
   770
46
f0616455056d Fix the uninitialized $path value errors I erroneously introduced on
Mahlon E. Smith <mahlon@laika.com>
parents: 44
diff changeset
   771
	# support empty 'cd' or 'cd ~' going to root
f0616455056d Fix the uninitialized $path value errors I erroneously introduced on
Mahlon E. Smith <mahlon@laika.com>
parents: 44
diff changeset
   772
	return $conf->{'basedn'} if ! $path || $path eq '~';
f0616455056d Fix the uninitialized $path value errors I erroneously introduced on
Mahlon E. Smith <mahlon@laika.com>
parents: 44
diff changeset
   773
30
e4b4b0968107 add method path_to_dn() to convert a given "path" to a DN
Peter Marschall <peter@adpm.de>
parents: 29
diff changeset
   774
	# return current base DN
33
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   775
	return $curbase if $path eq '.';
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   776
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   777
	# support 'cd -'
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   778
	return $self->{'previous_base'} if $path eq '-';
30
e4b4b0968107 add method path_to_dn() to convert a given "path" to a DN
Peter Marschall <peter@adpm.de>
parents: 29
diff changeset
   779
33
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   780
	# relative path, upwards
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   781
	#
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   782
	if ( $path =~ /^\.\./o ) {
30
e4b4b0968107 add method path_to_dn() to convert a given "path" to a DN
Peter Marschall <peter@adpm.de>
parents: 29
diff changeset
   783
		# support '..' (possibly iterated and as prefix to a DN)
33
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   784
		my @base = @{ ldap_explode_dn($curbase, casefold => 'none') };
30
e4b4b0968107 add method path_to_dn() to convert a given "path" to a DN
Peter Marschall <peter@adpm.de>
parents: 29
diff changeset
   785
e4b4b0968107 add method path_to_dn() to convert a given "path" to a DN
Peter Marschall <peter@adpm.de>
parents: 29
diff changeset
   786
		# deal with leading ..,
33
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   787
		while ( $path =~ /^\.\./ ) {
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   788
			shift( @base ) if @base;
30
e4b4b0968107 add method path_to_dn() to convert a given "path" to a DN
Peter Marschall <peter@adpm.de>
parents: 29
diff changeset
   789
			$path =~ s/^\.\.//;
33
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   790
			last if $path !~ /[,\/]\s*/;
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   791
			$path =~ s/[,\/]\s*//;
30
e4b4b0968107 add method path_to_dn() to convert a given "path" to a DN
Peter Marschall <peter@adpm.de>
parents: 29
diff changeset
   792
		}
e4b4b0968107 add method path_to_dn() to convert a given "path" to a DN
Peter Marschall <peter@adpm.de>
parents: 29
diff changeset
   793
33
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   794
		# append the new dn to the node if one was specified:
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   795
		#    cd ../../cn=somewhere  vs
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   796
		#    cd ../../
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   797
		#
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   798
		my $newbase_root = canonical_dn( \@base, casefold => 'none' );
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   799
		$path = $path ? $path . ',' . $newbase_root : $newbase_root;
30
e4b4b0968107 add method path_to_dn() to convert a given "path" to a DN
Peter Marschall <peter@adpm.de>
parents: 29
diff changeset
   800
	}
e4b4b0968107 add method path_to_dn() to convert a given "path" to a DN
Peter Marschall <peter@adpm.de>
parents: 29
diff changeset
   801
33
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   802
	# attach the base if it isn't already there (this takes care of
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   803
	# deeper relative nodes and absolutes)
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   804
	#
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   805
	else {
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   806
		$path = "$path," . $curbase unless $path =~ /$curbase/;
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   807
	}
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   808
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
   809
	return $path;
30
e4b4b0968107 add method path_to_dn() to convert a given "path" to a DN
Peter Marschall <peter@adpm.de>
parents: 29
diff changeset
   810
}
e4b4b0968107 add method path_to_dn() to convert a given "path" to a DN
Peter Marschall <peter@adpm.de>
parents: 29
diff changeset
   811
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   812
# given an array ref of shell-like globs, 
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   813
# make and return an LDAP filter object.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   814
#
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   815
sub make_filter 
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   816
{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   817
	my $self  = shift;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   818
	my $globs = shift or return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   819
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   820
	return unless ref $globs eq 'ARRAY';
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   821
	return unless scalar @$globs;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   822
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   823
	my $filter;
28
d42bd1b087a1 make_filter: cope with filters that are already parenthesized
Peter Marschall <peter@adpm.de>
parents: 27
diff changeset
   824
	$filter = join('', map { (/^\(.*\)$/o) ? $_ : "($_)" } @$globs);
d42bd1b087a1 make_filter: cope with filters that are already parenthesized
Peter Marschall <peter@adpm.de>
parents: 27
diff changeset
   825
	$filter = '(|' . $filter . ')'  if (scalar(@$globs) > 1);
d42bd1b087a1 make_filter: cope with filters that are already parenthesized
Peter Marschall <peter@adpm.de>
parents: 27
diff changeset
   826
	$filter = Net::LDAP::Filter->new($filter);
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   827
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   828
	if ( $filter ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   829
		$self->debug('Filter parsed as: ' . $filter->as_string() . "\n");
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   830
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   831
	else {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   832
		print "Error parsing filter.\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   833
		return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   834
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   835
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   836
	return $filter;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   837
}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   838
27
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
   839
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
   840
# check whether a given string may be a filter
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
   841
# Synopsis: $yesNo = $self->is_valid_filter($string);
34
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
   842
#
27
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
   843
sub is_valid_filter
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
   844
{
34
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
   845
	my $self   = shift;
27
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
   846
	my $filter = shift or return;
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
   847
34
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
   848
	return Net::LDAP::Filter->new( $filter ) ? 1 : 0;
27
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
   849
}
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
   850
34
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
   851
48
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   852
# Call code in subref $action, if there's any connection related errors,
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   853
# try it one additional time before giving up.  This should take care of
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   854
# most server disconnects due to timeout and other generic connection
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   855
# errors, and will attempt to re-establish a connection.
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   856
#
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   857
sub with_retry
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   858
{
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   859
	my $self = shift;
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   860
	my $action = shift;
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   861
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   862
	my $rv = $action->();
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   863
	if ( $rv->code() == LDAP_OPERATIONS_ERROR   ||
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   864
		 $rv->code() == LDAP_TIMELIMIT_EXCEEDED ||
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   865
		 $rv->code() == LDAP_BUSY               ||
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   866
		 $rv->code() == LDAP_UNAVAILABLE        ||
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   867
		 $rv->code() == LDAP_OTHER              ||
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   868
		 $rv->code() == LDAP_SERVER_DOWN        ||
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   869
		 $rv->code() == LDAP_TIMEOUT            ||
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   870
		 $rv->code() == LDAP_NO_MEMORY          ||
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   871
		 $rv->code() == LDAP_CONNECT_ERROR ) {
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   872
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   873
		$self->debug( "Error ". $rv->code() . ", retrying.\n" );
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   874
		$self->{'ldap'} = undef;
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   875
		$rv = $action->();
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   876
	}
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   877
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   878
	return $rv;
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   879
}
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   880
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
   881
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   882
# little. yellow. different. better.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   883
#
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   884
sub debug 
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   885
{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   886
	my $self = shift;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   887
	return unless $conf->{'debug'};
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   888
	print "\e[33m";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   889
	print shift();
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   890
	print "\e[0m";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   891
	return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   892
}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   893
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   894
# setup command autocompletes for
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   895
# all commands that have the same possible values
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   896
#
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   897
sub autocomplete_cwd
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   898
{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   899
	my $self = shift;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   900
	my $word = $_[0];
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   901
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   902
	return sort @{ $self->{'cwd_entries'} };
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   903
}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   904
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   905
sub comp_setenv
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   906
{ 
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   907
	my $self = shift;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   908
	return @{ $self->{'env'} };
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   909
}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   910
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   911
sub comp_create
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   912
{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   913
	my $self = shift;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   914
	return @{ $self->{'objectclasses'} } if $self->{'objectclasses'};
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   915
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   916
	my @oc_data = $self->{'schema'}->all_objectclasses();
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   917
	my @oc;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   918
	foreach my $o ( @oc_data ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   919
		push @oc, $o->{'name'};
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   920
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   921
	@oc = sort @oc;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   922
	$self->{'objectclasses'} = \@oc;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   923
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   924
	return @oc;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   925
}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   926
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   927
{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   928
	no warnings;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   929
	no strict 'refs';
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   930
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   931
	# command, alias
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   932
	my %cmd_map = (
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   933
		whoami => 'id',
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   934
		list   => 'ls',
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   935
		grep   => 'search',
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   936
		edit   => 'vi',
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   937
		delete => 'rm',
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   938
		copy   => 'cp',
3
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   939
		cat    => 'read',
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   940
		move   => 'mv',
3
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   941
		cd     => undef,
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   942
		passwd => undef
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   943
	);
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   944
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   945
	# setup autocompletes
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   946
	foreach ( %cmd_map ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   947
		next unless $_;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   948
		my $sub = "comp_$_";
3
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
   949
		*$sub   = \&autocomplete_cwd;
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   950
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   951
	*comp_touch  = \&comp_create;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   952
	*comp_export = \&comp_setenv;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   953
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   954
	# setup alias subs
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   955
	#
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   956
	# Term::Shell has an alias_* feature, but
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   957
	# it seems to work about 90% of the time.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   958
	# that last 10% is something of a mystery.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   959
	#
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   960
	$cmd_map{'create'} = 'touch';
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   961
	foreach my $cmd ( keys %cmd_map ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   962
		next unless defined $cmd_map{$cmd};
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   963
		my $alias_sub = 'run_' . $cmd_map{$cmd};
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   964
		my $real_sub  = 'run_' . $cmd;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   965
		*$alias_sub = \&$real_sub;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   966
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   967
}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   968
6
46dfe9d6f368 Update documentation, now that multiline edits work. Minor other
Mahlon E. Smith <mahlon@laika.com>
parents: 5
diff changeset
   969
46dfe9d6f368 Update documentation, now that multiline edits work. Minor other
Mahlon E. Smith <mahlon@laika.com>
parents: 5
diff changeset
   970
# Given an $arrayref, remove LDIF continuation wrapping,
46dfe9d6f368 Update documentation, now that multiline edits work. Minor other
Mahlon E. Smith <mahlon@laika.com>
parents: 5
diff changeset
   971
# effectively making each entry a single line.
46dfe9d6f368 Update documentation, now that multiline edits work. Minor other
Mahlon E. Smith <mahlon@laika.com>
parents: 5
diff changeset
   972
# 
5
78b2a48e07db Combine multiple lines into a single one before displaying LDIF. Patch
Mahlon E. Smith <mahlon@laika.com>
parents: 4
diff changeset
   973
sub unwrap {
78b2a48e07db Combine multiple lines into a single one before displaying LDIF. Patch
Mahlon E. Smith <mahlon@laika.com>
parents: 4
diff changeset
   974
	my $array = shift;
78b2a48e07db Combine multiple lines into a single one before displaying LDIF. Patch
Mahlon E. Smith <mahlon@laika.com>
parents: 4
diff changeset
   975
6
46dfe9d6f368 Update documentation, now that multiline edits work. Minor other
Mahlon E. Smith <mahlon@laika.com>
parents: 5
diff changeset
   976
	my $i = 1;
46dfe9d6f368 Update documentation, now that multiline edits work. Minor other
Mahlon E. Smith <mahlon@laika.com>
parents: 5
diff changeset
   977
	while ( $i < scalar(@$array) ) {
46dfe9d6f368 Update documentation, now that multiline edits work. Minor other
Mahlon E. Smith <mahlon@laika.com>
parents: 5
diff changeset
   978
		if ( $array->[$i] =~ /^\s/ ) {
46dfe9d6f368 Update documentation, now that multiline edits work. Minor other
Mahlon E. Smith <mahlon@laika.com>
parents: 5
diff changeset
   979
			$array->[ $i - 1 ] =~ s/\n$//;
46dfe9d6f368 Update documentation, now that multiline edits work. Minor other
Mahlon E. Smith <mahlon@laika.com>
parents: 5
diff changeset
   980
			$array->[ $i ] =~ s/^\s//;
46dfe9d6f368 Update documentation, now that multiline edits work. Minor other
Mahlon E. Smith <mahlon@laika.com>
parents: 5
diff changeset
   981
			splice( @$array, $i - 1, 2, $array->[$i - 1] . $array->[$i] );
46dfe9d6f368 Update documentation, now that multiline edits work. Minor other
Mahlon E. Smith <mahlon@laika.com>
parents: 5
diff changeset
   982
		}
46dfe9d6f368 Update documentation, now that multiline edits work. Minor other
Mahlon E. Smith <mahlon@laika.com>
parents: 5
diff changeset
   983
		else {
46dfe9d6f368 Update documentation, now that multiline edits work. Minor other
Mahlon E. Smith <mahlon@laika.com>
parents: 5
diff changeset
   984
			$i++;
5
78b2a48e07db Combine multiple lines into a single one before displaying LDIF. Patch
Mahlon E. Smith <mahlon@laika.com>
parents: 4
diff changeset
   985
		}
78b2a48e07db Combine multiple lines into a single one before displaying LDIF. Patch
Mahlon E. Smith <mahlon@laika.com>
parents: 4
diff changeset
   986
	}
78b2a48e07db Combine multiple lines into a single one before displaying LDIF. Patch
Mahlon E. Smith <mahlon@laika.com>
parents: 4
diff changeset
   987
}
78b2a48e07db Combine multiple lines into a single one before displaying LDIF. Patch
Mahlon E. Smith <mahlon@laika.com>
parents: 4
diff changeset
   988
6
46dfe9d6f368 Update documentation, now that multiline edits work. Minor other
Mahlon E. Smith <mahlon@laika.com>
parents: 5
diff changeset
   989
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   990
###############################################################
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   991
#
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   992
# SHELL METHODS
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   993
#
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   994
###############################################################
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   995
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   996
# don't die on a newline
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   997
#
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   998
sub run_ { return; }
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
   999
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1000
# print shell debug actions
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1001
# 
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1002
sub precmd
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1003
{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1004
	my $self = shift;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1005
	my ( $handler, $cmd, $args ) = @_;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1006
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1007
	my $term = $self->term();
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1008
	eval { $term->WriteHistory("$ENV{'HOME'}/.shelldap_history"); };
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1009
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1010
	return unless $conf->{'debug'};
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1011
	$self->debug( "$$cmd (" . ( join ' ', @$args ) . "), calling '$$handler'\n" );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1012
	return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1013
} 
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1014
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1015
sub run_cat 
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1016
{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1017
	my $self  = shift;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1018
	my $dn    = shift;
21
cf8013cbfb58 slight cleanup: make more clear, it's an array
Peter Marschall <peter@adpm.de>
parents: 20
diff changeset
  1019
	my @attrs = (@_) ? @_ : ('*');
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1020
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1021
	unless ( $dn ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1022
		print "No dn provided.\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1023
		return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1024
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1025
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1026
	# support '.'
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1027
	$dn = $self->base() if $dn eq '.';
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1028
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1029
	# support globbing
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1030
	my $s;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1031
	if ( $dn eq '*' ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1032
		$s = $self->search({
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1033
			scope  => 'one',
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1034
			vals   => 1,
21
cf8013cbfb58 slight cleanup: make more clear, it's an array
Peter Marschall <peter@adpm.de>
parents: 20
diff changeset
  1035
			attrs  => \@attrs
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1036
		});
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1037
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1038
	elsif ( $dn =~ /\*/ ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1039
		$s = $self->search({
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1040
			scope  => 'one',
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1041
			vals   => 1,
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1042
			filter => $dn,
21
cf8013cbfb58 slight cleanup: make more clear, it's an array
Peter Marschall <peter@adpm.de>
parents: 20
diff changeset
  1043
			attrs  => \@attrs
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1044
		});
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1045
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1046
	else {
31
a3a710f720dd run_cat: convert to using path_to_dn()
Peter Marschall <peter@adpm.de>
parents: 30
diff changeset
  1047
		# convert given path to DN
33
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
  1048
		$dn = $self->path_to_dn( $dn );
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1049
		$s = $self->search({
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1050
			base   => $dn,
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1051
			vals   => 1,
21
cf8013cbfb58 slight cleanup: make more clear, it's an array
Peter Marschall <peter@adpm.de>
parents: 20
diff changeset
  1052
			attrs  => \@attrs
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1053
		});
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1054
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1055
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1056
	if ( $s->{'code'} ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1057
		print $s->{'message'} . "\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1058
		return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1059
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1060
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1061
	foreach my $e ( @{ $s->{'entries'} } ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1062
		$self->ldif->write_entry( $e );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1063
		print "\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1064
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1065
	return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1066
}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1067
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1068
sub run_cd 
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1069
{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1070
	my $self	= shift;
41
3e7c107f8b93 Take only second argument for run_{cd,edit,mkdir}
Salvatore Bonaccorso <carnil@debian.org>
parents: 40
diff changeset
  1071
	my $newbase = shift;
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1072
30
e4b4b0968107 add method path_to_dn() to convert a given "path" to a DN
Peter Marschall <peter@adpm.de>
parents: 29
diff changeset
  1073
	# convert given path to a DN
33
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
  1074
	$newbase = $self->path_to_dn( $newbase );
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
  1075
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1076
	unless ( $self->is_valid_dn( $newbase ) ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1077
		print "No such object\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1078
		return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1079
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1080
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1081
	# store old base
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1082
	$self->{'previous_base'} = $self->base();
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1083
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1084
	# update new base
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1085
	$self->base( $newbase );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1086
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1087
	# get new 'cwd' listing
26
68318d115f6c fix attribute lists for LDAP queries
Peter Marschall <peter@adpm.de>
parents: 25
diff changeset
  1088
	my $s = $self->search({ scope => 'one', attrs => [ '1.1' ] });
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1089
	if ( $s->{'code'} ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1090
		print "$s->{'message'}\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1091
		return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1092
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1093
	$self->update_entries( search => $s );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1094
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1095
	# reflect cwd change in prompt
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1096
	$self->update_prompt();
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1097
	return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1098
}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1099
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1100
sub run_clear
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1101
{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1102
	my $self = shift;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1103
	system('clear');
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1104
	return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1105
}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1106
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1107
sub run_copy
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1108
{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1109
	my $self = shift;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1110
	my ( $s_dn, $d_dn ) = @_;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1111
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1112
	unless ( $s_dn ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1113
		print "No source dn provided.\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1114
		return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1115
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1116
	unless ( $d_dn ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1117
		print "No destination dn provided.\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1118
		return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1119
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1120
31
a3a710f720dd run_cat: convert to using path_to_dn()
Peter Marschall <peter@adpm.de>
parents: 30
diff changeset
  1121
	# convert given source path to DN
33
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
  1122
	$s_dn = $self->path_to_dn( $s_dn );
31
a3a710f720dd run_cat: convert to using path_to_dn()
Peter Marschall <peter@adpm.de>
parents: 30
diff changeset
  1123
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1124
	my $s = $self->search({ base => $s_dn, vals => 1 });
16
a2e3faa3d2fc use symbolic LDAP error codes instead of numbers
Peter Marschall <peter@adpm.de>
parents: 15
diff changeset
  1125
	unless ( $s->{'code'} == LDAP_SUCCESS ) {
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1126
		print "No such object\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1127
		return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1128
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1129
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1130
	# see if we're copying the entry to a totally new path
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1131
	my ( $new_dn, $old_dn );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1132
	( $d_dn, $new_dn ) = ( $1, $2 ) if $d_dn =~ /^([\w=]+),(.*)$/;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1133
	if ( $new_dn ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1134
		unless ( $self->is_valid_dn( $new_dn ) ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1135
			print "Invalid destination.\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1136
			return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1137
		}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1138
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1139
	else {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1140
		$new_dn = $self->base();
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1141
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1142
	$old_dn = $1 if $s_dn =~ /^[\w=]+,(.*)$/;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1143
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1144
	# get the source object
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1145
	my $e = ${ $s->{'entries'} }[0];
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1146
	$e->dn( $s_dn );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1147
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1148
	# add changes in new entry instead of modifying existing
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1149
	$e->changetype('add'); 
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1150
	$e->dn( "$d_dn,$new_dn" );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1151
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1152
	# get the unique attribute from the dn for modification
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1153
	# perhaps there is a better way to do this...?
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1154
	#
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1155
	my ( $uniqkey, $uniqval ) = ( $1, $2 )
14
b8fae8fb7942 Allow '-' on RDN name when copying
Giacomo Tenaglia <Giacomo.Tenaglia@cern.ch>
parents: 12
diff changeset
  1156
	  if $d_dn =~ /^([\.\w\-]+)(?:\s+)?=(?:\s+)?([\.\-\s\w]+),?/;
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1157
	unless ( $uniqkey && $uniqval ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1158
		print "Unable to parse unique values from rdn.\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1159
		return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1160
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1161
	$e->replace( $uniqkey => $uniqval );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1162
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1163
	# update
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1164
	my $rv = $e->update( $self->ldap() );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1165
	print $rv->error , "\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1166
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1167
	# clear caches
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1168
	$self->{'cache'}->{ $new_dn } = {} if $new_dn;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1169
	$self->{'cache'}->{ $old_dn } = {} if $old_dn;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1170
	$self->update_entries( clearcache => 1 );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1171
	return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1172
}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1173
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1174
sub run_create
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1175
{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1176
	my $self = shift;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1177
	my @ocs  = @_;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1178
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1179
	my ( $fh, $fname ) =
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1180
		File::Temp::tempfile( 'shelldap_XXXXXXXX', DIR => '/tmp', UNLINK => 1 );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1181
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1182
	# first print out the dn and object classes.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1183
	print $fh 'dn: ???,', $self->base(), "\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1184
	foreach my $oc ( sort @ocs ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1185
		print $fh "objectClass: $oc\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1186
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1187
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1188
	# now gather attributes for requested objectClasses
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1189
	#
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1190
	my ( %seen, @must_attr, @may_attr );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1191
	foreach my $oc ( sort @ocs ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1192
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1193
		# required
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1194
		my @must = $self->{'schema'}->must( $oc );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1195
		foreach my $attr ( sort { $a->{'name'} cmp $b->{'name'} } @must ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1196
			next if $attr->{'name'} =~ /^objectclass$/i;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1197
			next if $seen{ $attr->{'name'} };
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1198
			push @must_attr, $attr->{'name'};
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1199
			$seen{ $attr->{'name'} }++;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1200
		}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1201
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1202
		# optional
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1203
		my @may  = $self->{'schema'}->may( $oc );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1204
		foreach my $attr ( sort { $a->{'name'} cmp $b->{'name'} } @may ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1205
			next if $attr->{'name'} =~ /^objectclass$/i;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1206
			next if $seen{ $attr->{'name'} };
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1207
			push @may_attr, $attr->{'name'};
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1208
			$seen{ $attr->{'name'} }++;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1209
		}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1210
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1211
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1212
	# print attributes
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1213
	print $fh "$_: \n"   foreach @must_attr;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1214
	print $fh "# $_: \n" foreach @may_attr;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1215
	close $fh;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1216
	my $hash_a = $self->chksum( $fname );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1217
	system( $self->{'editor'}, $fname ) && die "Unable to launch editor: $!\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1218
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1219
	# hash compare
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1220
	my $hash_b = $self->chksum( $fname );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1221
	if ( $hash_a eq $hash_b ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1222
		print "Entry not modified.\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1223
		unlink $fname;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1224
		return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1225
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1226
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1227
	# load in LDIF
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1228
	my $ldif = Net::LDAP::LDIF->new( $fname, 'r', onerror => 'warn' );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1229
	my $e	= $ldif->read_entry();
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1230
	unless ( $e ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1231
		print "Unable to parse LDIF.\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1232
		unlink $fname;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1233
		return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1234
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1235
	$e->changetype('add');
48
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1236
	my $create = sub { return $e->update($self->ldap()) };
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1237
	my $rv = $self->with_retry( $create );
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1238
	print $rv->error(), "\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1239
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1240
	$self->update_entries( clearcache => 1 ) unless $rv->code();
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1241
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1242
	unlink $fname;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1243
	return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1244
}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1245
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1246
sub run_delete
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1247
{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1248
	my $self = shift;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1249
	my @DNs  = @_;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1250
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1251
	unless ( scalar @DNs ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1252
		print "No dn specified.\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1253
		return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1254
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1255
6
46dfe9d6f368 Update documentation, now that multiline edits work. Minor other
Mahlon E. Smith <mahlon@laika.com>
parents: 5
diff changeset
  1256
	my $filter;
46dfe9d6f368 Update documentation, now that multiline edits work. Minor other
Mahlon E. Smith <mahlon@laika.com>
parents: 5
diff changeset
  1257
	unless ( $DNs[0] eq '*' ) {
46dfe9d6f368 Update documentation, now that multiline edits work. Minor other
Mahlon E. Smith <mahlon@laika.com>
parents: 5
diff changeset
  1258
		$filter = $self->make_filter( \@DNs ) or return;
46dfe9d6f368 Update documentation, now that multiline edits work. Minor other
Mahlon E. Smith <mahlon@laika.com>
parents: 5
diff changeset
  1259
	}
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1260
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1261
	my $s = $self->search({ scope => 'one', filter => $filter });
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1262
	if ( $s->{'code'} ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1263
		print "$s->{'message'}\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1264
		return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1265
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1266
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1267
	print "Are you sure? [N/y]: ";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1268
	chomp( my $resp = <STDIN> );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1269
	return unless $resp =~ /^y/i;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1270
   
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1271
	foreach my $e ( @{ $s->{'entries'} } ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1272
		my $dn = $e->dn();
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1273
		my $rv = $self->ldap->delete( $dn );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1274
		print "$dn: ", $rv->error(), "\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1275
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1276
   
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1277
	$self->update_entries( clearcache => 1 );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1278
	return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1279
}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1280
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1281
sub run_edit
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1282
{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1283
	my $self = shift;
41
3e7c107f8b93 Take only second argument for run_{cd,edit,mkdir}
Salvatore Bonaccorso <carnil@debian.org>
parents: 40
diff changeset
  1284
	my $dn   = shift;
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1285
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1286
	unless ( $dn ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1287
		print "No dn provided.\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1288
		return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1289
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1290
31
a3a710f720dd run_cat: convert to using path_to_dn()
Peter Marschall <peter@adpm.de>
parents: 30
diff changeset
  1291
	# convert given path to DN
33
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
  1292
	$dn = $self->path_to_dn( $dn );
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1293
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1294
	my $s = $self->search({ base => $dn, vals => 1 });
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1295
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1296
	if ( $s->{'code'} ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1297
		print $s->{'message'} . "\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1298
		return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1299
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1300
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1301
	# fetch entry and write it out to disk
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1302
	my $e = ${ $s->{'entries'} }[0];
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1303
	my $ldif = $self->ldif(1);
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1304
	$ldif->write_entry( $e );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1305
	$ldif->done();  # force sync
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1306
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1307
	# load it into an array for potential comparison
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1308
	open LDIF, "$self->{'ldif_fname'}" or return;
6
46dfe9d6f368 Update documentation, now that multiline edits work. Minor other
Mahlon E. Smith <mahlon@laika.com>
parents: 5
diff changeset
  1309
	my @orig_ldif = <LDIF>;
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1310
	close LDIF;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1311
48
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1312
	# append optional, unused attributes as comments
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1313
	# for fast reference.
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1314
	#
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1315
	open LDIF, ">> $self->{'ldif_fname'}";
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1316
	my %current_attrs = map { $_ => 1 } $e->attributes();
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1317
	foreach my $oc ( $e->get_value('objectClass') ) {
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1318
		my @may = $self->{'schema'}->may( $oc );
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1319
		foreach my $opt_attr ( sort { $a->{'name'} cmp $b->{'name'} } @may ) {
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1320
			next if $current_attrs{ $opt_attr->{'name'} };
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1321
			print LDIF "# " . $opt_attr->{'name'} . ":\n";
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1322
		}
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1323
	}
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1324
	close LDIF;
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1325
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1326
	# checksum it, then open it in an editor
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1327
	my $hash_a = $self->chksum( $self->{'ldif_fname'} );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1328
	system( "$self->{'editor'} $self->{'ldif_fname'}" ) &&
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1329
		die "Unable to launch editor: $!\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1330
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1331
	# detect a total lack of change
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1332
	my $hash_b = $self->chksum( $self->{'ldif_fname'} );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1333
	if ( $hash_a eq $hash_b ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1334
		print "Entry not modified.\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1335
		unlink $self->{'ldif_fname'};
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1336
		return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1337
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1338
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1339
	# check changes for basic LDIF validity
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1340
	my $new_e = $self->load_ldif( $self->{'ldif_fname'} );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1341
	unless ( $new_e ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1342
		print "Unable to parse LDIF.\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1343
		unlink $self->{'ldif_fname'};
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1344
		return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1345
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1346
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1347
	# load changes into a new array for comparison
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1348
	open LDIF, "$self->{'ldif_fname'}" or return;
6
46dfe9d6f368 Update documentation, now that multiline edits work. Minor other
Mahlon E. Smith <mahlon@laika.com>
parents: 5
diff changeset
  1349
	my @new_ldif = <LDIF>;
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1350
	close LDIF;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1351
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1352
	$e->changetype('modify');
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1353
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1354
	my $parse = sub {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1355
		my $line = shift || $_;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1356
		return if $line	 =~ /^\#/; # ignore comments
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1357
		my ( $attr, $val ) = ( $1, $2 ) if $line =~ /^(.+?): (.*)$/;
6
46dfe9d6f368 Update documentation, now that multiline edits work. Minor other
Mahlon E. Smith <mahlon@laika.com>
parents: 5
diff changeset
  1358
		return unless $attr;
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1359
		return if index($attr, ':') != -1;  # ignore base64
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1360
		return ( $attr, $val );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1361
	};
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1362
6
46dfe9d6f368 Update documentation, now that multiline edits work. Minor other
Mahlon E. Smith <mahlon@laika.com>
parents: 5
diff changeset
  1363
	unwrap( \@orig_ldif );
46dfe9d6f368 Update documentation, now that multiline edits work. Minor other
Mahlon E. Smith <mahlon@laika.com>
parents: 5
diff changeset
  1364
	unwrap( \@new_ldif );
5
78b2a48e07db Combine multiple lines into a single one before displaying LDIF. Patch
Mahlon E. Smith <mahlon@laika.com>
parents: 4
diff changeset
  1365
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1366
	my $diff = Algorithm::Diff->new( \@orig_ldif, \@new_ldif );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1367
	HUNK:
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1368
	while ( $diff->Next() ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1369
		next if $diff->Same();
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1370
		my $diff_bit = $diff->Diff();
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1371
		my %seen_attr;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1372
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1373
		# total deletions
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1374
		if ( $diff_bit == 1 ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1375
			foreach ( $diff->Items(1) ) {
48
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1376
				my ( $attr, $val ) = $parse->( $_ ) or next;
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1377
				$self->debug("DELETE: $_");
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1378
				$e->delete( $attr => [ $val ] );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1379
			}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1380
		}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1381
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1382
		# new insertions
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1383
		if ( $diff_bit == 2 ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1384
			foreach ( $diff->Items(2) ) {
48
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1385
				my ( $attr, $val ) = $parse->( $_ ) or next;
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1386
				$self->debug("INSERT: $_");
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1387
				$e->add( $attr => $val );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1388
			}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1389
		}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1390
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1391
		# replacements
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1392
		if ( $diff_bit == 3 ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1393
			foreach ( $diff->Items(2) ) {
48
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1394
				my ( $attr, $val ) = $parse->( $_ ) or next;
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1395
				$self->debug("MODIFY: $_");
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1396
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1397
				my $cur_vals = $e->get_value( $attr, asref => 1 ) || [];
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1398
				my $cur_valcount = scalar @$cur_vals;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1399
				next if $cur_valcount == 0; # should have been an 'add'
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1400
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1401
				# replace immediately 
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1402
				#
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1403
				if ( $cur_valcount == 1 ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1404
					$e->replace( $attr => $val );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1405
				}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1406
				else {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1407
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1408
					# make sure the replace doesn't squash
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1409
					# other attributes listed with the same name
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1410
					#
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1411
					next if $seen_attr{ $attr };
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1412
					my @new_vals;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1413
					foreach my $line ( @new_ldif ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1414
						my ( $new_attr, $new_val ) = $parse->( $line ) or next;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1415
						next unless $new_attr eq $attr;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1416
						$seen_attr{ $attr }++;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1417
						push @new_vals, $new_val;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1418
					}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1419
					$e->replace( $attr => \@new_vals );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1420
				}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1421
			}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1422
		}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1423
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1424
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1425
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1426
	unlink $self->{'ldif_fname'};
48
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1427
	my $update = sub { return $e->update( $self->ldap ); };
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1428
	my $rv = $self->with_retry( $update );
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1429
	print $rv->error(), "\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1430
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1431
	return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1432
}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1433
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1434
sub run_env
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1435
{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1436
	my $self = shift;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1437
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1438
	foreach ( sort @{ $self->{'env'} } ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1439
		print "$_: ";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1440
		print $conf->{$_} ? $conf->{$_} : 0; 
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1441
		print "\n"
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1442
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1443
}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1444
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1445
sub run_grep
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1446
{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1447
	my $self = shift;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1448
	my ( $recurse, $filter, $base ) = @_;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1449
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1450
	# set 'recursion'
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1451
	unless ( $recurse && $recurse =~ /\-r|recurse/ ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1452
		# shift args to the left
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1453
		( $recurse, $filter, $base ) = ( undef, $recurse, $filter );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1454
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1455
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1456
	$filter = Net::LDAP::Filter->new( $filter );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1457
	unless ( $filter ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1458
		print "Invalid search filter.\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1459
		return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1460
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1461
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1462
	# support '*'
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1463
	$base = $self->base() if ! $base or $base eq '*';
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1464
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1465
	unless ( $base ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1466
		print "No search base specified.\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1467
		return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1468
	}
33
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
  1469
31
a3a710f720dd run_cat: convert to using path_to_dn()
Peter Marschall <peter@adpm.de>
parents: 30
diff changeset
  1470
	# convert base path to DN
33
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
  1471
	$base = $self->path_to_dn( $base );
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1472
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1473
	$self->debug("Filter parsed as: " . $filter->as_string() . "\n");
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1474
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1475
	my $s = $self->search(
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1476
		{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1477
			scope  => $recurse ? 'sub' : 'one',
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1478
			base   => $base,
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1479
			filter => $filter
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1480
		}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1481
	);
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1482
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1483
	foreach my $e ( @{ $s->{'entries'} } ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1484
		my $dn = $e->dn();
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1485
		print "$dn\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1486
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1487
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1488
	return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1489
}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1490
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1491
# override internal help functions
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1492
# with pod2usage
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1493
#
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1494
sub run_help 
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1495
{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1496
	return Pod::Usage::pod2usage(
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1497
		-exitval  => 'NOEXIT',
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1498
		-verbose  => 99,
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1499
		-sections => 'SHELL COMMANDS'
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1500
	);
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1501
}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1502
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1503
sub run_list
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1504
{
34
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1505
	my $self  = shift;
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1506
	my @args  = @_;
27
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1507
	my @attrs = ();
34
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1508
	my $filter;
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1509
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1510
	# flag booleans
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1511
	my ( $recurse, $long );
27
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1512
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1513
	# parse arguments: [ <option> ...] [<filter> ...] [<attribute> ...]
34
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1514
	if ( scalar @args ) {
27
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1515
		# options: support '-l' or '-R' listings
34
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1516
		if ( $args[0] =~ /^\-(\w+)/o ) {
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1517
			my $flags = $1;
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1518
			$recurse  = $flags =~ /R/;
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1519
			$long	  = $flags =~ /l/;
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1520
			shift( @args );
27
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1521
		}
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1522
27
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1523
		my @filters;
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1524
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1525
		# get filter elements from argument list
34
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1526
		while ( @args && $self->is_valid_filter($args[0]) ) {
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1527
			push( @filters, shift(@args) );
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1528
		}
27
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1529
34
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1530
		push( @filters, '(objectClass=*)' ) unless scalar @filters;
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1531
		
27
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1532
		# construct OR'ed filter from filter elements
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1533
		$filter = $self->make_filter( \@filters );
27
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1534
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1535
		# remaining arguments must be attributes
34
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1536
		push( @attrs, @args );
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1537
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1538
34
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1539
	# Get all attributes if none are specified, and we're in long-list mode.
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1540
	push( @attrs, '*' )  if $long && ! scalar @attrs;
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1541
4
5a65bc849363 Append a trailing slash to entries that contain other entries. Thanks
Mahlon E. Smith <mahlon@martini.nu>
parents: 3
diff changeset
  1542
	my $s = $self->search({
5a65bc849363 Append a trailing slash to entries that contain other entries. Thanks
Mahlon E. Smith <mahlon@martini.nu>
parents: 3
diff changeset
  1543
		scope  => $recurse ? 'sub' : 'one',
5a65bc849363 Append a trailing slash to entries that contain other entries. Thanks
Mahlon E. Smith <mahlon@martini.nu>
parents: 3
diff changeset
  1544
		vals   => 1,
5a65bc849363 Append a trailing slash to entries that contain other entries. Thanks
Mahlon E. Smith <mahlon@martini.nu>
parents: 3
diff changeset
  1545
		filter => $filter,
27
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1546
		attrs  => [ @attrs, 'hasSubordinates' ]
4
5a65bc849363 Append a trailing slash to entries that contain other entries. Thanks
Mahlon E. Smith <mahlon@martini.nu>
parents: 3
diff changeset
  1547
	});
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1548
	if ( $s->{'code'} ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1549
		print "$s->{'message'}\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1550
		return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1551
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1552
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1553
	# if an entry doesn't have a description field,
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1554
	# try and show some nice defaults for ls -l !
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1555
	# 
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1556
	# objectClass -> Attribute to show
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1557
	#
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1558
	my %descs = %{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1559
		$conf->{'descmaps'}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1560
		  || {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1561
			posixAccount => 'gecos',
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1562
			posixGroup   => 'gidNumber',
4
5a65bc849363 Append a trailing slash to entries that contain other entries. Thanks
Mahlon E. Smith <mahlon@martini.nu>
parents: 3
diff changeset
  1563
			ipHost	     => 'ipHostNumber',
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1564
		  }
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1565
	  };
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1566
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1567
	# iterate and print
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1568
	#
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1569
	my $dn_count = 0;
34
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1570
	my $base = $self->base();
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1571
	foreach my $e ( sort { $a->dn() cmp $b->dn() } @{ $s->{'entries'} } ) {
27
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1572
		my $dn = $e->dn();
34
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1573
		next if lc( $dn ) eq lc( $base );
27
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1574
34
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1575
		if ( ! $long ) {
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1576
			# strip the current base from the dn, if we're recursing and not in long mode
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1577
			if ( $recurse ) {
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1578
				$dn =~ s/,$base//oi;
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1579
			}
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1580
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1581
			# only show RDN unless -l was given
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1582
			else {
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1583
				$dn = canonical_dn( [shift(@{ldap_explode_dn($dn, casefold => 'none')})], casefold => 'none' )
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1584
			}
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1585
		}
4
5a65bc849363 Append a trailing slash to entries that contain other entries. Thanks
Mahlon E. Smith <mahlon@martini.nu>
parents: 3
diff changeset
  1586
5a65bc849363 Append a trailing slash to entries that contain other entries. Thanks
Mahlon E. Smith <mahlon@martini.nu>
parents: 3
diff changeset
  1587
		# if this entry is a container for other entries, append a
5a65bc849363 Append a trailing slash to entries that contain other entries. Thanks
Mahlon E. Smith <mahlon@martini.nu>
parents: 3
diff changeset
  1588
		# trailing slash.
35
3e5572aeee55 Make sure the hasSubordinates attribute is defined before checking its
Mahlon E. Smith <mahlon@martini.nu>
parents: 34
diff changeset
  1589
		$dn .= '/'  if $e->get_value('hasSubordinates') &&
3e5572aeee55 Make sure the hasSubordinates attribute is defined before checking its
Mahlon E. Smith <mahlon@martini.nu>
parents: 34
diff changeset
  1590
			$e->get_value('hasSubordinates') eq 'TRUE';
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1591
34
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1592
		# additional arguments/attributes were given; show their values
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1593
		#
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1594
		if ( scalar @args ) {
27
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1595
			my @elements = ( $dn );
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1596
34
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1597
			foreach my $attr ( @args ) {
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1598
				my @vals = $e->get_value( $attr );
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1599
				push( @elements, join(',', @vals) );
27
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1600
			}
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1601
34
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1602
			print join( "\t", @elements )."\n";
27
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1603
		}
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1604
		else {
27
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1605
			# show descriptions
34
40c3719c87d4 fix 'ls -R' output, minor style cleanup
Mahlon E. Smith <mahlon@martini.nu>
parents: 33
diff changeset
  1606
			my $desc = $e->get_value( 'description' );
27
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1607
			if ( $desc ) {
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1608
				$desc =~ s/\n.*//s; # 1st line only
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1609
				$dn .= " ($desc)";
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1610
			}
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1611
27
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1612
			# no desc?  Try and infer something useful
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1613
			# to display.
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1614
			else {
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1615
27
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1616
				# pull objectClasses, hash for lookup speed
48
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1617
				my @oc = $e->get_value( 'objectClass' );
27
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1618
				my %ochash;
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1619
				map { $ochash{$_} = 1 } @oc;
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1620
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1621
				foreach my $d_listing ( sort keys %descs ) {
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1622
					if ( exists $ochash{ $d_listing } ) {
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1623
						my $str = $e->get_value( $descs{ $d_listing }, asref => 1 );
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1624
						$dn .= ' (' . (join ', ', @$str) . ')' if $str && scalar @$str;
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1625
					}
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1626
					next;
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1627
				}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1628
			}
27
7d170d1bc17b run_list: new argument syntax: [<options>] [<filter>] [<attributes>]
Peter Marschall <peter@adpm.de>
parents: 26
diff changeset
  1629
			print "$dn\n";
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1630
		}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1631
		$dn_count++;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1632
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1633
	
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1634
	print "\n$dn_count " .
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1635
		( $dn_count == 1 ? 'object.' : 'objects.') .
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1636
		"\n" if $long;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1637
	return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1638
}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1639
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1640
sub run_mkdir
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1641
{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1642
	my $self = shift;
41
3e7c107f8b93 Take only second argument for run_{cd,edit,mkdir}
Salvatore Bonaccorso <carnil@debian.org>
parents: 40
diff changeset
  1643
	my $dir  = shift;
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1644
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1645
	unless ( $dir ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1646
		print "No 'directory' provided.\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1647
		return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1648
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1649
38
12f279ef4f9d Backout the additional objectClasses patch for mkdir: same behavior can
Mahlon E. Smith <mahlon@martini.nu>
parents: 37
diff changeset
  1650
	# normalize name, if it is not yet a legal DN
12f279ef4f9d Backout the additional objectClasses patch for mkdir: same behavior can
Mahlon E. Smith <mahlon@martini.nu>
parents: 37
diff changeset
  1651
	$dir = 'ou=' . $dir unless canonical_dn( $dir );
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1652
38
12f279ef4f9d Backout the additional objectClasses patch for mkdir: same behavior can
Mahlon E. Smith <mahlon@martini.nu>
parents: 37
diff changeset
  1653
	# convert given path to full DN
12f279ef4f9d Backout the additional objectClasses patch for mkdir: same behavior can
Mahlon E. Smith <mahlon@martini.nu>
parents: 37
diff changeset
  1654
	$dir = $self->path_to_dn( $dir );
29
bd95c3aea253 mkdir: support more objectclasses
Peter Marschall <peter@adpm.de>
parents: 28
diff changeset
  1655
bd95c3aea253 mkdir: support more objectclasses
Peter Marschall <peter@adpm.de>
parents: 28
diff changeset
  1656
	# get RDN: naming attributes (lower-case) and their values
38
12f279ef4f9d Backout the additional objectClasses patch for mkdir: same behavior can
Mahlon E. Smith <mahlon@martini.nu>
parents: 37
diff changeset
  1657
	my %rdn = %{ shift(@{ ldap_explode_dn($dir, casefold => 'lower') }) };
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1658
38
12f279ef4f9d Backout the additional objectClasses patch for mkdir: same behavior can
Mahlon E. Smith <mahlon@martini.nu>
parents: 37
diff changeset
  1659
	# add
48
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1660
	my $mkdir = sub {
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1661
		return $self->ldap()->add( $dir, attr => [
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1662
			objectClass => [ 'top', 'organizationalUnit' ], %rdn
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1663
		]);
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1664
	};
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1665
48
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1666
	my $rv = $self->with_retry( $mkdir );
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1667
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1668
	print $rv->error(), "\n";
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1669
	$self->update_entries( clearcache => 1 );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1670
	return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1671
}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1672
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1673
sub run_move
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1674
{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1675
	my $self = shift;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1676
	my ( $s_dn, $d_dn ) = @_;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1677
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1678
	unless ( $s_dn ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1679
		print "No source dn provided.\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1680
		return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1681
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1682
	unless ( $d_dn ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1683
		print "No destination dn provided.\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1684
		return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1685
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1686
31
a3a710f720dd run_cat: convert to using path_to_dn()
Peter Marschall <peter@adpm.de>
parents: 30
diff changeset
  1687
	# convert given source path to DN
33
057fefab56b0 Repair broken path behavior, remove unneeded #path_to_dn 'relative'
Mahlon E. Smith <mahlon@martini.nu>
parents: 32
diff changeset
  1688
	$s_dn = $self->path_to_dn( $s_dn );
31
a3a710f720dd run_cat: convert to using path_to_dn()
Peter Marschall <peter@adpm.de>
parents: 30
diff changeset
  1689
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1690
	unless ( $self->is_valid_dn( $s_dn ) ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1691
		print "No such object\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1692
		return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1693
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1694
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1695
	# see if we're moving the entry to a totally new path
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1696
	my ( $new_dn, $old_dn );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1697
	( $d_dn, $new_dn ) = ( $1, $2 ) if $d_dn =~ /^([\w=]+),(.*)$/;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1698
	$old_dn = $1 if $s_dn =~ /^[\w=]+,(.*)$/;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1699
48
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1700
	my $moddn = sub {
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1701
		return $self->ldap()->moddn(
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1702
			$s_dn,
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1703
			newrdn	     => $d_dn,
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1704
			deleteoldrdn => 1,
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1705
			newsuperior  => $new_dn
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1706
		);
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1707
	};
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1708
	my $rv = $self->with_retry( $moddn );
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1709
	print $rv->error(), "\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1710
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1711
	# clear caches
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1712
	$self->{'cache'}->{ $new_dn } = {} if $new_dn;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1713
	$self->{'cache'}->{ $old_dn } = {} if $old_dn;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1714
	$self->update_entries( clearcache => 1 );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1715
	return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1716
}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1717
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1718
sub run_passwd 
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1719
{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1720
	my $self = shift;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1721
	my $dn   = shift || $self->base();
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1722
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1723
	$self->{'root_dse'} ||= $self->ldap->root_dse();
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1724
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1725
	my $pw_extension = '1.3.6.1.4.1.4203.1.11.1';
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1726
	unless ( $self->{'root_dse'}->supported_extension( $pw_extension ) ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1727
		print "Sorry, password changes not supported by LDAP server.\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1728
		return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1729
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1730
31
a3a710f720dd run_cat: convert to using path_to_dn()
Peter Marschall <peter@adpm.de>
parents: 30
diff changeset
  1731
	# convert given path to DN
40
c6a3abc56c74 Fix bug introduced in rev:a3a710f720dd with passwd arguments.
Mahlon E. Smith <mahlon@martini.nu>
parents: 38
diff changeset
  1732
	$dn = $self->path_to_dn( $dn );
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1733
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1734
	my $s = $self->search( { base => $dn, scope => 'base' } );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1735
	if ( $s->{'code'} ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1736
		print $s->{'message'}, "\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1737
		return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1738
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1739
	my $e = ${ $s->{'entries'} }[0];
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1740
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1741
	unless ( $e->exists('userPassword') ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1742
		print "No userPassword attribute for $dn\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1743
		return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1744
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1745
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1746
	print "Changing password for $dn\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1747
	Term::ReadKey::ReadMode 2;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1748
	print "Enter new password: ";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1749
	chomp( my $pw  = <STDIN> );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1750
	print "\nRetype new password: ";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1751
	chomp( my $pw2 = <STDIN> );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1752
	print "\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1753
	Term::ReadKey::ReadMode 0;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1754
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1755
	if ( $pw ne $pw2 ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1756
		print "Sorry, passwords do not match.\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1757
		return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1758
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1759
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1760
	my $rv = $self->ldap->set_password(
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1761
		user	  => $dn,
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1762
		newpasswd => $pw
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1763
	);
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1764
16
a2e3faa3d2fc use symbolic LDAP error codes instead of numbers
Peter Marschall <peter@adpm.de>
parents: 15
diff changeset
  1765
	if ( $rv->code() == LDAP_SUCCESS ) {
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1766
		print "Password updated successfully.\n";
48
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1767
	}
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1768
	else {
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1769
		print "Password error: " . $rv->error() . "\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1770
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1771
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1772
	return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1773
}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1774
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1775
sub run_pwd 
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1776
{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1777
	my $self = shift;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1778
	print $self->base() . "\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1779
	return;   
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1780
}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1781
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1782
sub run_setenv
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1783
{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1784
	my $self = shift;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1785
	my ( $key, $val ) = @_;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1786
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1787
	( $key, $val ) = split /=/, $key if $key && ! defined $val;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1788
	return unless $key && defined $val;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1789
	$key = lc $key;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1790
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1791
	$conf->{$key} = $val;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1792
	return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1793
}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1794
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1795
sub run_whoami
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1796
{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1797
	my $self = shift;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1798
	print $conf->{'binddn'} || 'anonymous bind';
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1799
	print "\n";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1800
	return;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1801
}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1802
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1803
###############################################################
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1804
#
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1805
# MAIN
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1806
#
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1807
###############################################################
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1808
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1809
package main;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1810
use strict;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1811
use warnings;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1812
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1813
$0 = 'shelldap';
48
fe27dfe5179e More robust path for connection retries. Show optional, unused
Mahlon E. Smith <mahlon@laika.com>
parents: 46
diff changeset
  1814
my $VERSION = '0.8';
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1815
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1816
use Getopt::Long;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1817
use YAML::Syck;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1818
use Pod::Usage;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1819
eval 'use Term::ReadLine::Gnu';
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1820
warn qq{Term::ReadLine::Gnu not installed.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1821
Continuing, but shelldap is of limited usefulness without it.\n\n} if $@;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1822
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1823
# get config - rc file first, command line overrides
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1824
use vars '$conf';
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1825
$conf = load_config() || {};
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1826
Getopt::Long::GetOptions(
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1827
	$conf, 
18
db47ba64ebda accept short option names for some options
Peter Marschall <peter@adpm.de>
parents: 17
diff changeset
  1828
	'server|H=s',
db47ba64ebda accept short option names for some options
Peter Marschall <peter@adpm.de>
parents: 17
diff changeset
  1829
	'binddn|D=s',
db47ba64ebda accept short option names for some options
Peter Marschall <peter@adpm.de>
parents: 17
diff changeset
  1830
	'basedn|b=s',
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1831
	'cacheage=i',
42
b8c6d4e8f828 Add a flag to force a password prompt, so you can override credentials
Mahlon E. Smith <mahlon@laika.com>
parents: 41
diff changeset
  1832
	'promptpass|W',
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1833
	'timeout=i',
3
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
  1834
	'tls_cacert=s',
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
  1835
	'tls_cert=s',
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
  1836
	'tls_key=s',
37
7a8855e7cfb8 Add a --version flag.
Mahlon E. Smith <mahlon@martini.nu>
parents: 36
diff changeset
  1837
	'tls', 'debug', 'version',
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1838
	 help => sub {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1839
		Pod::Usage::pod2usage(
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1840
			-verbose => 1,
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1841
			-message => "\n$0 command line flags\n" . '-' x 65
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1842
		);
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1843
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1844
);
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1845
37
7a8855e7cfb8 Add a --version flag.
Mahlon E. Smith <mahlon@martini.nu>
parents: 36
diff changeset
  1846
# show version
7a8855e7cfb8 Add a --version flag.
Mahlon E. Smith <mahlon@martini.nu>
parents: 36
diff changeset
  1847
if ( $conf->{'version'} ) {
7a8855e7cfb8 Add a --version flag.
Mahlon E. Smith <mahlon@martini.nu>
parents: 36
diff changeset
  1848
	print "$VERSION\n";
7a8855e7cfb8 Add a --version flag.
Mahlon E. Smith <mahlon@martini.nu>
parents: 36
diff changeset
  1849
	exit( 0 );
7a8855e7cfb8 Add a --version flag.
Mahlon E. Smith <mahlon@martini.nu>
parents: 36
diff changeset
  1850
}
7a8855e7cfb8 Add a --version flag.
Mahlon E. Smith <mahlon@martini.nu>
parents: 36
diff changeset
  1851
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1852
# defaults
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1853
$conf->{'confpath'} = "$ENV{'HOME'}/.shelldap.rc";
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1854
$conf->{'cacheage'} ||= 300;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1855
$conf->{'timeout'}  ||= 10;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1856
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1857
# create and enter shell loop
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1858
my $shell = LDAP::Shell->new();
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1859
$shell->cmdloop();
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1860
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1861
# load YAML config into global conf.
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1862
#
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1863
sub load_config
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1864
{
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1865
	my ( $d, $data );
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1866
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1867
	my $confpath;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1868
	my @confs = (
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1869
		"$ENV{'HOME'}/.shelldap.rc",
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1870
		'/usr/local/etc/shelldap.conf',
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1871
		'/etc/shelldap.conf',
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1872
	);
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1873
	foreach ( @confs ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1874
		if ( -e $_ ) {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1875
			$confpath = $_;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1876
			last;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1877
		}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1878
	}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1879
	$confpath or return undef;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1880
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1881
	open YAML, $confpath or return undef;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1882
	do {
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1883
		local $/ = undef;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1884
		$data = <YAML>;  # slurp!
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1885
	};
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1886
	close YAML;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1887
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1888
	eval { $conf = YAML::Syck::Load( $data ) };
3
0f815f3daaf7 Add options to support ssl key verification when connecting with TLS.
Mahlon E. Smith <mahlon@martini.nu>
parents: 1
diff changeset
  1889
	die "Invalid YAML in $confpath\n" if $@;
0
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1890
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1891
	return $conf;
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1892
}
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1893
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1894
## EOF
f7990a76e217 Restructure for tags/branches.
mahlon
parents:
diff changeset
  1895