docs-xml/wscript_build

   1 #!/usr/bin/env python
   2 from samba_utils import save_file
   3 import os
   4 manpages='''
   5          manpages/cifsdd.8
   6          manpages/dbwrap_tool.1
   7          manpages/eventlogadm.8
   8          manpages/idmap_ad.8
   9          manpages/idmap_autorid.8
  10          manpages/idmap_hash.8
  11          manpages/idmap_ldap.8
  12          manpages/idmap_nss.8
  13          manpages/idmap_rfc2307.8
  14          manpages/idmap_rid.8
  15          manpages/idmap_script.8
  16          manpages/idmap_tdb.8
  17          manpages/idmap_tdb2.8
  18          manpages/libsmbclient.7
  19          manpages/lmhosts.5
  20          manpages/log2pcap.1
  21          manpages/mdsearch.1
  22          manpages/mvxattr.1
  23          manpages/net.8
  24          manpages/nmbd.8
  25          manpages/nmblookup.1
  26          manpages/ntlm_auth.1
  27          manpages/pdbedit.8
  28          manpages/profiles.1
  29          manpages/rpcclient.1
  30          manpages/samba-dcerpcd.8
  31          manpages/samba-regedit.8
  32          manpages/samba-tool.8
  33          manpages/samba.7
  34          manpages/samba.8
  35          manpages/samba_downgrade_db.8
  36          manpages/sharesec.1
  37          manpages/smbcacls.1
  38          manpages/smbclient.1
  39          manpages/smbcontrol.1
  40          manpages/smbcquotas.1
  41          manpages/smbd.8
  42          manpages/smbget.1
  43          manpages/smbpasswd.5
  44          manpages/smbpasswd.8
  45          manpages/smbspool_krb5_wrapper.8
  46          manpages/smbspool.8
  47          manpages/samba-bgqd.8
  48          manpages/smbstatus.1
  49          manpages/smbtar.1
  50          manpages/smbtree.1
  51          manpages/testparm.1
  52          manpages/traffic_learner.7
  53          manpages/traffic_replay.7
  54          manpages/wbinfo.1
  55          manpages/winbindd.8
  56          manpages/samba-log-parser.1
  57          manpages/wspsearch.1
  58          '''
  59
  60 pam_winbind_manpages = '''
  61                        manpages/pam_winbind.8
  62                        manpages/pam_winbind.conf.5
  63                        '''
  64
  65 krb5_locator_manpages = 'manpages/winbind_krb5_locator.8'
  66 krb5_localauth_manpages = 'manpages/winbind_krb5_localauth.8'
  67
  68 winexe_manpages = 'manpages/winexe.1'
  69
  70 vfs_module_manpages = ['vfs_acl_tdb',
  71                        'vfs_acl_xattr',
  72                        'vfs_aio_fork',
  73                        'vfs_aio_pthread',
  74                        'vfs_io_uring',
  75                        'vfs_audit',
  76                        'vfs_btrfs',
  77                        'vfs_cacheprime',
  78                        'vfs_cap',
  79                        'vfs_catia',
  80                        'vfs_ceph',
  81                        'vfs_ceph_snapshots',
  82                        'vfs_commit',
  83                        'vfs_crossrename',
  84                        'vfs_default_quota',
  85                        'vfs_dirsort',
  86                        'vfs_expand_msdfs',
  87                        'vfs_extd_audit',
  88                        'vfs_fake_perms',
  89                        'vfs_fileid',
  90                        'vfs_fruit',
  91                        'vfs_full_audit',
  92                        'vfs_glusterfs',
  93                        'vfs_glusterfs_fuse',
  94                        'vfs_gpfs',
  95                        'vfs_linux_xfs_sgid',
  96                        'vfs_media_harmony',
  97                        'vfs_nfs4acl_xattr',
  98                        'vfs_offline',
  99                        'vfs_prealloc',
 100                        'vfs_preopen',
 101                        'vfs_readahead',
 102                        'vfs_readonly',
 103                        'vfs_recycle',
 104                        'vfs_shadow_copy',
 105                        'vfs_shadow_copy2',
 106                        'vfs_shell_snap',
 107                        'vfs_snapper',
 108                        'vfs_streams_depot',
 109                        'vfs_streams_xattr',
 110                        'vfs_syncops',
 111                        'vfs_time_audit',
 112                        'vfs_tsmsm',
 113                        'vfs_unityed_media',
 114                        'vfs_virusfilter',
 115                        'vfs_widelinks',
 116                        'vfs_worm',
 117                        'vfs_xattr_tdb',
 118                        'vfs_zfsacl' ]
 119
 120 def generate_path_entity_list():
 121     entities = bld.pathconfig_entities()
 122
 123     # We need this if we build with Heimdal as we can't easily make
 124     # the whole option go away
 125     mit_kdc_path = '""'
 126     # The MIT krb5kdc path is set if we build with MIT Kerberos
 127     if bld.CONFIG_SET('MIT_KDC_PATH'):
 128         mit_kdc_path = bld.CONFIG_GET('MIT_KDC_PATH')
 129
 130     t = "\n".join(entities) +\
 131         "\n" +\
 132         "<!ENTITY pathconfig.MITKDCPATH   " + mit_kdc_path + ">\n" +\
 133         "\n"
 134     return t
 135
 136 def smbdotconf_generate_parameter_list_file(task):
 137     parameter_all = task.outputs[0].bldpath(task.env)
 138     articles = task.inputs
 139
 140     t = "<!DOCTYPE section [\n" +\
 141         generate_path_entity_list() + \
 142         "]>\n" +\
 143         "<section>\n" +\
 144         "".join(art.read() for art in articles) +\
 145         "</section>\n"
 146
 147
 148     save_file(parameter_all, t , create_dir=True)
 149     return 0
 150
 151 # Since nothing really forces sorting in glob, we have to sort by file name
 152 # POSIX file systems aren't required to return sorted content but we want
 153 # smb.conf parameters to be sorted alphabetically
 154 parameter_all = 'smbdotconf/parameters.all.xml'
 155 sources = bld.path.ant_glob("smbdotconf/**/*.xml", flat=False, excl=parameter_all)
 156 articles = " ".join(sorted([x.path_from(bld.path) for x in sources],
 157                            key=lambda m: m.split(os.sep)[-1]))
 158
 159 bld.SAMBA_GENERATOR(parameter_all,
 160                     source=articles,
 161                     target=parameter_all,
 162                     rule=smbdotconf_generate_parameter_list_file)
 163
 164 def generate_path_entity_file(task):
 165     path_entities_file = task.outputs[0].bldpath(task.env)
 166
 167     save_file(path_entities_file,
 168               generate_path_entity_list(),
 169               create_dir=True)
 170     return 0
 171
 172 path_entities = 'build/DTD/samba.build.pathconfig'
 173
 174 bld.SAMBA_GENERATOR(path_entities,
 175                     source=articles,
 176                     target=path_entities,
 177                     rule=generate_path_entity_file,
 178                     dep_vars=bld.dynconfig_varnames())
 179
 180
 181 def SMBDOTCONF_MANPAGE(bld, target):
 182     ''' assemble and build smb.conf.5 manual page'''
 183     bld.SAMBAMANPAGES(target, parameter_all)
 184
 185 if ('XSLTPROC_MANPAGES' in bld.env and bld.env['XSLTPROC_MANPAGES']):
 186
 187     SMBDOTCONF_MANPAGE(bld, 'manpages/smb.conf.5')
 188     bld.SAMBAMANPAGES(manpages)
 189
 190     if bld.CONFIG_SET('WITH_PAM_MODULES') and bld.CONFIG_SET('HAVE_PAM_START'):
 191         bld.SAMBAMANPAGES(pam_winbind_manpages)
 192
 193     if bld.CONFIG_SET('HAVE_KRB5_LOCATE_PLUGIN_H'):
 194         bld.SAMBAMANPAGES(krb5_locator_manpages)
 195
 196     if bld.CONFIG_SET('HAVE_KRB5_LOCALAUTH_PLUGIN_H'):
 197         bld.SAMBAMANPAGES(krb5_localauth_manpages)
 198
 199     if conf.env.build_winexe == True:
 200         bld.SAMBAMANPAGES(winexe_manpages)
 201
 202     if bld.CONFIG_SET('ENABLE_SELFTEST'):
 203         bld.SAMBAMANPAGES('manpages/vfstest.1')
 204
 205     for manpage in vfs_module_manpages:
 206         if bld.SAMBA3_IS_ENABLED_MODULE(manpage):
 207             bld.SAMBAMANPAGES('manpages/%s.8' % manpage)