Vh\ddlmZdZdZdZddlZddlZddlZddlZddl Z ddl Z ddl Z ddl Z ddl mZmZddlmZddlmZGd d Zdd Zd Zd ZddZdZdZdZedk(reyy)) annotationsaC --- module: find author: Brian Coca (@bcoca) version_added: "2.0" short_description: Return a list of files based on specific criteria description: - Return a list of files based on specific criteria. Multiple criteria are AND'd together. - For Windows targets, use the M(ansible.windows.win_find) module instead. - This module does not use the C(find) command, it is a much simpler and slower Python implementation. It is intended for small and simple uses. Those that need the extra power or speed and have expertise with the UNIX command, should use it directly. options: age: description: - Select files whose age is equal to or greater than the specified time. - Use a negative age to find files equal to or less than the specified time. - You can choose seconds, minutes, hours, days, or weeks by specifying the first letter of any of those words (e.g., "1w"). type: str patterns: default: [] description: - One or more (shell or regex) patterns, which type is controlled by O(use_regex) option. - The patterns restrict the list of files to be returned to those whose basenames match at least one of the patterns specified. Multiple patterns can be specified using a list. - The pattern is matched against the file base name, excluding the directory. - When using regexen, the pattern MUST match the ENTIRE file name, not just parts of it. So if you are looking to match all files ending in .default, you'd need to use C(.*\.default) as a regexp and not just C(\.default). - This parameter expects a list, which can be either comma separated or YAML. If any of the patterns contain a comma, make sure to put them in a list to avoid splitting the patterns in undesirable ways. - Defaults to V(*) when O(use_regex=False), or V(.*) when O(use_regex=True). type: list aliases: [ pattern ] elements: str excludes: description: - One or more (shell or regex) patterns, which type is controlled by O(use_regex) option. - Items whose basenames match an O(excludes) pattern are culled from O(patterns) matches. Multiple patterns can be specified using a list. type: list aliases: [ exclude ] version_added: "2.5" elements: str contains: description: - A regular expression or pattern which should be matched against the file content. - If O(read_whole_file=false) it matches against the beginning of the line (uses V(re.match(\))). If O(read_whole_file=true), it searches anywhere for that pattern (uses V(re.search(\))). - Works only when O(file_type) is V(file). type: str read_whole_file: description: - When doing a C(contains) search, determines whether the whole file should be read into memory or if the regex should be applied to the file line-by-line. - Setting this to C(true) can have performance and memory implications for large files. - This uses V(re.search(\)) instead of V(re.match(\)). type: bool default: false version_added: "2.11" paths: description: - List of paths of directories to search. All paths must be fully qualified. - From ansible-core 2.18 and onwards, the data type has changed from C(str) to C(path). type: list required: true aliases: [ name, path ] elements: path file_type: description: - Type of file to select. - The V(link) and V(any) choices were added in Ansible 2.3. type: str choices: [ any, directory, file, link ] default: file recurse: description: - If target is a directory, recursively descend into the directory looking for files. type: bool default: no size: description: - Select files whose size is equal to or greater than the specified size. - Use a negative size to find files equal to or less than the specified size. - Unqualified values are in bytes but b, k, m, g, and t can be appended to specify bytes, kilobytes, megabytes, gigabytes, and terabytes, respectively. - Size is not evaluated for directories. type: str age_stamp: description: - Choose the file property against which we compare age. type: str choices: [ atime, ctime, mtime ] default: mtime hidden: description: - Set this to V(true) to include hidden files, otherwise they will be ignored. type: bool default: no mode: description: - Choose objects matching a specified permission. This value is restricted to modes that can be applied using the python C(os.chmod) function. - The mode can be provided as an octal such as V("0644") or as symbolic such as V(u=rw,g=r,o=r). type: raw version_added: '2.16' exact_mode: description: - Restrict mode matching to exact matches only, and not as a minimum set of permissions to match. type: bool default: true version_added: '2.16' follow: description: - Set this to V(true) to follow symlinks in path for systems with python 2.6+. type: bool default: no get_checksum: description: - Set this to V(true) to retrieve a file's SHA1 checksum. type: bool default: no use_regex: description: - If V(false), the patterns are file globs (shell). - If V(true), they are python regexes. type: bool default: no depth: description: - Set the maximum number of levels to descend into. - Setting O(recurse=false) will override this value, which is effectively depth 1. - Default is unlimited depth. type: int version_added: "2.6" encoding: description: - When doing a O(contains) search, determine the encoding of the files to be searched. type: str version_added: "2.17" limit: description: - Limit the maximum number of matching paths returned. After finding this many, the find action will stop looking. - Matches are made from the top, down (i.e. shallowest directory first). - If not set, or set to v(null), it will do unlimited matches. - Default is unlimited matches. type: int version_added: "2.18" extends_documentation_fragment: action_common_attributes attributes: check_mode: details: since this action does not modify the target it just executes normally during check mode support: full diff_mode: support: none platform: platforms: posix seealso: - module: ansible.windows.win_find a - name: Recursively find /tmp files older than 2 days ansible.builtin.find: paths: /tmp age: 2d recurse: yes - name: Recursively find /tmp files older than 4 weeks and equal or greater than 1 megabyte ansible.builtin.find: paths: /tmp age: 4w size: 1m recurse: yes - name: Recursively find /var/tmp files with last access time greater than 3600 seconds ansible.builtin.find: paths: /var/tmp age: 3600 age_stamp: atime recurse: yes - name: Find /var/log files equal or greater than 10 megabytes ending with .old or .log.gz ansible.builtin.find: paths: /var/log patterns: '*.old,*.log.gz' size: 10m # Note that YAML double quotes require escaping backslashes but yaml single quotes do not. - name: Find /var/log files equal or greater than 10 megabytes ending with .old or .log.gz via regex ansible.builtin.find: paths: /var/log patterns: "^.*?\\.(?:old|log\\.gz)$" size: 10m use_regex: yes - name: Find /var/log all directories, exclude nginx and mysql ansible.builtin.find: paths: /var/log recurse: no file_type: directory excludes: 'nginx,mysql' # When using patterns that contain a comma, make sure they are formatted as lists to avoid splitting the pattern - name: Use a single pattern that contains a comma formatted as a list ansible.builtin.find: paths: /var/log file_type: file use_regex: yes patterns: ['^_[0-9]{2,4}_.*.log$'] - name: Use multiple patterns that contain a comma formatted as a YAML list ansible.builtin.find: paths: /var/log file_type: file use_regex: yes patterns: - '^_[0-9]{2,4}_.*.log$' - '^[a-z]{1,5}_.*log$' - name: Find file containing "wally" without necessarily reading all files ansible.builtin.find: paths: /var/log file_type: file contains: wally read_whole_file: true patterns: "^.*\\.log$" use_regex: true recurse: true limit: 1 a0 files: description: All matches found with the specified criteria (see stat module for full output of each dictionary) returned: success type: list sample: [ { path: "/var/tmp/test1", mode: "0644", "...": "...", checksum: 16fac7be61a6e4591a33ef4b729c5c3302307523 }, { path: "/var/tmp/test2", "...": "..." }, ] matched: description: Number of matches returned: success type: int sample: 14 examined: description: Number of filesystem objects looked at returned: success type: int sample: 34 skipped_paths: description: skipped paths and reasons they were skipped returned: success type: dict sample: {"/laskdfj": "'/laskdfj' is not a directory"} version_added: '2.12' N)to_text to_native) AnsibleModule) string_typesceZdZdZy)_Objectc N|jD]\}}t|||yN)itemssetattr)selfkwargskvs D/home/dcms/DCMS/lib/python3.12/site-packages/ansible/modules/find.py__init__z_Object.__init__+s'LLN DAq D!Q  N)__name__ __module__ __qualname__rrrr r *s rr c|s|sy|r|r2|s0|D]*}tj|}|j|s*yy|ra|r_|D]Z}tj|}|j|s*|D]+}tj|}|j|s*yyy|r"|s |D]}tj||syy|rA|r?|D]:}tj||s|D]}tj||syyy)zfilter using glob patternsTF)recompilematchfnmatch)fpatternsexcludes use_regexpres rpfilterr%0s H H JJqM771: : 1( JJqM771:%)JJqM771:#()  .  H ??1a(  ( ??1a(%)"??1a0#()   rc|y|dk\r|t|d|zz t|k\ry|dkr|t|d|zz t|kryy)zfilter files older than ageTrzst_%sF)getattrabs)stnowage timestamps r agefilterr-WsY { cGB)(;<<CH qS72w':;;s3xG rc|y|dk\r|jt|k\ry|dkr|jt|kryy)zfilter files greater than sizeTrF)st_sizer()r)sizes r sizefilterr1bs? | rzzSY. bjjCI- rc|ytj|} t||5}|r1t|j |j cdddS|D]}|j |sdddy dddy#1swYyxYw#t$r}|d}~wt$r}|d}d|d|}t||d}~wt$rYywxYw)a Filter files which contain the given expression :arg fsname: Filename to scan for lines matching a pattern :arg pattern: Pattern to look for inside of line :arg encoding: Encoding of the file to be scanned :arg read_whole_file: If true, the whole file is read into memory before the regex is applied against it. Otherwise, the regex is applied line-by-line. :rtype: bool :returns: True if one of the lines in fsname matches the pattern. Otherwise False NT)encodingz@None (default determined by the Python built-in function "open")zFailed to read the file z- due to an encoding error. current encoding: F) rropenboolsearchreadr LookupErrorUnicodeDecodeError Exception) fsnamepatternr3read_whole_fileprogrliner$msgs r contentfilterrAms ::g D &8 , DKK12   ::d#     $ % $   $  YH(0]^f]ghn!#    sd B*B BB2B3B<B>BB BB CB C*C CCc |sytj|j} t|d}tj|}|r||k(St||zS#t$r|j t d|}YQwxYw)NTr)st_mode)statS_IMODErDint ValueError_symbolic_mode_to_octalr r5)r)modeexactmodulerDs r mode_filterrMs ll2::&GH4| << D $ $  H--ga.@$GHs A%BBcd}d} tj|jj} t j |jj}iddtj|jzdtj|jdtj|jdtj|jdtj|jdtj |jd tj"|jd tj$|jd |jd |jd |j&d|j(d|j*d|j,d|j.d|j0d|j2||t5|jtj6zt5|jtj8zt5|jtj:zt5|jtj<zt5|jtj>zt5|jtj@zt5|jtjBzt5|jtjDzt5|jtjFzt5|jtjHzt5|jtjJzd S#t$rYLwxYw#t$rY2wxYw)NrJz%04oisdirischrisblkisregisfifoislnkissockuidgidr0inodedevnlinkatimemtimectime) gr_namepw_namewusrrusrxusrwgrprgrpxgrpwothrothxothisuidisgid)&pwdgetpwuidst_uidr`r:grpgetgrgidst_gidr_rErFrDS_ISDIRS_ISCHRS_ISBLKS_ISREGS_ISFIFOS_ISLNKS_ISSOCKr/st_inost_devst_nlinkst_atimest_mtimest_ctimer5S_IWUSRS_IRUSRS_IXUSRS_IWGRPS_IRGRPS_IXGRPS_IWOTHS_IROTHS_IXOTHS_ISUIDS_ISGID)r)r`r_s rstatinforsGG ,,ryy)11 ,,ryy)11 bjj11 bjj)  bjj)  bjj)   bjj)   $-- +   bjj)  $-- +  ryy  ryy       ryy      ! " # $RZZ$,,./RZZ$,,./RZZ$,,./RZZ$,,./RZZ$,,./RZZ$,,./RZZ$,,./RZZ$,,./RZZ$,,./bjj4<</0bjj4<</0=        s")M/)M?/ M<;M<? N  N c "ttdSidtddddgddtdgdgd d tdd gd dtd dtdddtd dgddtd dtd dgddtd dtdddtdddtddd tddd!tddd"td#d$td%d&tddd'td d(td#d)}|j}|d$r?t|d$ts,|j d*|d$j jz+|ds|d!rd,g|d<nd-g|d<g}ifd.}|dd}ntjd/|dj}d0d1d2d3d4d5}|r=t|jd0|j|jd6d0z}n|j |dd78|dd}ntjd9|dj}d0d:d;d}|r=t|jd0|j|jd6d0z}n|j |dd?@|d( |d(dAkr|j dB|d(z+tj} dC} dA} d} |dD]} tj j#| st%dDt'| ztj(| ||ddED]\}}}| t+|zt+|z} ||zD]=}tj j-tj j/||}|d"r| j1tj j2tj j2z}t|j5tj j2t|j5tj j2z d0z}||d"kDr|dd=tj j7|j9dFr|ds6 tj:|}d|i}|ddJk(rtE||d|d |d!rtG|| |drtI||d$|d&|r|jKtM|tOjP|jRr|d r|jU||dK<tOjP|jRr tW|r|jY|n|jY|ntOjZ|jRrt|ddLk(rltE||d|d |d!rtG|| |drtI||d$|d&|r|jKtM||jY|n[tOjP|jRr|ddk(rtE||d|d |d!rtG|| |dr tW|rt]||d|d'|drtI||d$|d&|r|jKtM||d r|jU||dK<|jY|ntOj^|jRro|ddMk(rgtE||d|d |d!rPtG|| |dr?tI||d$|d&|r+|jKtM||jY|t+||d(k(sf$r<}|jAdG|dHtC|dItC||<d} Yd}~d}~wwxYw#t$$r?}tC|| <|jAdOtC| dP| dId} Yd}~d}~wwxYw)TNpathslistTnamepath)typerequiredaliaseselementsrr<str)rdefaultrrr exclude)rrrcontains)rr=r5F)rr file_typefile)any directoryrlink)rrchoicesr+ age_stampr])r\r^r]r0recursehiddenfollow get_checksumr!depthrGrJraw exact_moder3limit) argument_specsupports_check_modezRargument 'mode' is not a string and conversion is not allowed, value is of type %s)r@z.**c|jtjtjtjfvrt ||j <y|r )errnoEPERMEACCESENOENTrfilename)r$skippeds rhandle_walk_errorsz main..handle_walk_errorss< 77u{{ELL%,,? ?")!*GAJJ  rz^(-?\d+)(s|m|h|d|w)?$<iiQi: )smhdwzfailed to process age)r+r@z^(-?\d+)(b|k|m|g|t)?$iii@l)brrgtzfailed to process size)r0r@rz+limit cannot be %d (use None for unlimited)zAll paths examinedz'%s' is not a directory)onerror followlinkstopdown.zSkipped entry 'z' due to this access issue:  rchecksumrrzLimit of matches reachedz Skipped 'z!' path due to this access issue: z2Not all paths examined, check warnings for details)fileschangedr@matchedexamined skipped_pathsr)1rdictparams isinstancer fail_json __class__rrrlowerrGgroupgettimeosrrPr:rwalklennormpathjoinrstripsepcountbasename startswithlstatIOErrorOSErrorwarnrr%r-rMupdaterrErurDsha1r1appendrrrArw exit_json)rLrfilelistrr+rseconds_per_unitr0bytes_per_unitr*r@looked has_warningsnpathrootdirsrfsobjr;wpathrr)r$r#rrs @rmainrsU  FTFF;KV\] vrI;QVW v {UK u%  !fe<  v?cd  %  w@[\ 5! fe4 VU3 VU3 659 6 E" 5!! "6# $u%% &E"' *!-F2]]F f~jFdgmntgugghIhII   *  + "&F: "%F: HG e} HH-ve}/B/B/D E!"$UP aggaj/$4$8$8Q$GGC   4K  L f~ HH-vf~/C/C/E F t'gV qwwqz?^%7%7 A%FFD   &.6N  O g"vg!';JVT[_\] ))+C C FLR Q 77==' 9IeU[[QSQXQXQ\Q\E]A^ ^ab b 6'?2 $Q$ww''/::3?xHX !XXf- (Ak*e3#E6*+=vj?QSYZeSfg )"c3{8K L +Bv|@TV\ ]HHXb\2#||BJJ7F>K.a.a a8a 1`> 8a>a a b4b  b__main__)NNF)F) __future__r DOCUMENTATIONEXAMPLESRETURNrrrorrlrrEr+ansible.module_utils.common.text.convertersrransible.module_utils.basicransible.module_utils.sixrr r%r-r1rArMrrrrrrrs#e PE N B  J41  $N"J &-`hvV zFr