├── .gitignore ├── LICENSE.md ├── README.md ├── Template.csv ├── postinstall.py └── profile_generator.py /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_* 2 | *.pkginfo 3 | *.mobileconfig 4 | *.plist 5 | plistlibtest.py 6 | *_uninstallscript.py 7 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | PrinterGenerator 2 | ================ 3 | 4 | This script will generate profile (mobileconfig) for [Munki](https://github.com/munki/munki/wiki) to install a printer. 5 | 6 | CSV usage is currently not implemented. 7 | 8 | ### Command-line options: 9 | 10 | A full description of usage is available with: 11 | 12 | ``` 13 | ./print_generator.py -h 14 | usage: print_generator.py [-h] [--printername PRINTERNAME] [--driver DRIVER] 15 | [--address ADDRESS] [--location LOCATION] 16 | [--displayname DISPLAYNAME] [--desc DESC] 17 | [--options [OPTIONS [OPTIONS ...]]] 18 | [--version VERSION] [--csv CSV] 19 | 20 | Generate a Munki nopkg-style pkginfo for printer installation. 21 | 22 | optional arguments: 23 | -h, --help show this help message and exit 24 | --printername PRINTERNAME 25 | Name of printer queue. May not contain spaces, tabs, # 26 | or /. Required. 27 | --driver DRIVER Name of driver file in 28 | /Library/Printers/PPDs/Contents/Resources/. Can be 29 | relative or full path. Required. 30 | --address ADDRESS IP or DNS address of printer. If no protocol is 31 | specified, defaults to lpd://. Required. 32 | --location LOCATION Location name for printer. Optional. Defaults to 33 | printername. 34 | --displayname DISPLAYNAME 35 | Display name for printer (and Munki pkginfo). 36 | Optional. Defaults to printername. 37 | --desc DESC Description for Munki pkginfo only. Optional. 38 | 39 | --version VERSION Version number of Munki pkginfo. Optional. Defaults to 40 | 1.0. 41 | --option key=value [--option key2=value2 ...] Adds options for printer 42 | ``` 43 | -------------------------------------------------------------------------------- /Template.csv: -------------------------------------------------------------------------------- 1 | Printer Name,Location,Display Name,Address,Driver,Description,Options 2 | MyPrinterQueue,Tech Office,My Printer Queue,10.0.0.1,HP officejet 5500 series.ppd.gz,Black and white printer in Tech Office,HPOptionDuplexer=True OutputMode=normal -------------------------------------------------------------------------------- /postinstall.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | ''' 3 | Refreshes MCX for all users in /Users 4 | ''' 5 | from os import listdir 6 | from subprocess import call 7 | 8 | for user in listdir('/Users'): 9 | if user != "Shared" and user != ".localized": 10 | print user 11 | call(['/usr/bin/mcxrefresh', '-n', user]) 12 | 13 | 14 | print "All Users mcxprinters refreshed!" 15 | -------------------------------------------------------------------------------- /profile_generator.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | ''' 3 | Generates Printer Profile 4 | ''' 5 | # Libraries 6 | import os 7 | import argparse 8 | import gzip 9 | import subprocess 10 | from plistlib import writePlist 11 | from uuid import uuid4 12 | 13 | path = os.path.dirname(os.path.abspath(__file__)) 14 | postinstall_script = os.path.join(path, "postinstall.py") 15 | 16 | profileuuid = str(uuid4()) 17 | payloaduuid = str(uuid4()) 18 | _options = {} 19 | cwd = os.getcwd() 20 | 21 | def main(): 22 | ''' 23 | Main Function 24 | ''' 25 | # Variables 26 | 27 | # Parser Options 28 | parser = argparse.ArgumentParser( 29 | description='Generate a Configuration Profile for printer installation.') 30 | parser.add_argument( 31 | '--printername', 32 | help='Name of printer queue. May not contain spaces, tabs,' 33 | '# or /. Required.', 34 | required=True) 35 | group = parser.add_mutually_exclusive_group(required=True) 36 | group.add_argument( 37 | '--driver', 38 | help='Name of driver file in' 39 | '/Library/Printers/PPDs/Contents/Resources/.' 40 | 'Can be relative or full path. Required OR use --generic.') 41 | group.add_argument('--generic', help='Use the Generic' 42 | 'Postscript Printer driver. Required OR' \ 43 | 'use --driver /PATH/TO/Driver .', 44 | action='store_true') 45 | parser.add_argument( 46 | '--address', 47 | help='IP or DNS address of printer.' 48 | 'If no protocol is specified, defaults to socket://.' 49 | 'Required.', 50 | required=True) 51 | parser.add_argument( 52 | '--location', 53 | help='Location name for printer.' 54 | 'Optional. Defaults to printername.') 55 | parser.add_argument( 56 | '--displayname', 57 | help='Display name for printer (and Munki pkginfo).' 58 | 'Optional. Defaults to printername.') 59 | parser.add_argument( 60 | '--version', 61 | help='Version number of Munki pkginfo.' 62 | 'Optional. Defaults to 1.0.', 63 | default='1.0') 64 | parser.add_argument( 65 | '--organization', 66 | help='Change Organization of Profile.' 67 | 'Defaults to GitHub', 68 | default="GitHub") 69 | parser.add_argument( 70 | '--identifier', 71 | help='Change Profile + Payload Identifier before uuid.' 72 | 'Payload UUID is appended to ensure it is unique.' 73 | 'Defaults to com.github.wardsparadox', 74 | default="com.github.wardsparadox") 75 | parser.add_argument( 76 | '--option', 77 | help='Add an option in addition to the "printer is shared" option.' 78 | 'Bool values must be in True or False form.', 79 | action='append') 80 | parser.add_argument( 81 | '--munkiimport', 82 | help='Use munkiimport tools to import profile to munki_repo', 83 | action='store_true') 84 | 85 | # parser.add_argument('--csv', help='Path to CSV file containing printer info.' 86 | # 'If CSV is provided, all other options are ignored.') 87 | 88 | # Main 89 | args = parser.parse_args() 90 | printername = str(args.printername).replace('-', '_') 91 | if args.displayname: 92 | displayName = args.displayname 93 | else: 94 | displayName = str(printername) 95 | 96 | if args.location: 97 | location = args.location 98 | else: 99 | location = printername 100 | 101 | if args.version: 102 | version = str(args.version) 103 | else: 104 | version = "1.0" 105 | 106 | if args.generic: 107 | driver = "/System/Library/Frameworks/ApplicationServices.framework/Versions/A/Frameworks/PrintCore.framework/Versions/A/Resources/Generic.ppd" 108 | with open(driver, 'rb') as ppd: 109 | for line in ppd: 110 | if "*NickName:" in line: 111 | model = line.split('"')[1] 112 | ppd.close() 113 | if args.driver: 114 | if args.driver.startswith('/Library'): 115 | # Assume the user passed in a full path rather than a relative filename 116 | driver = args.driver 117 | with gzip.open(driver, 'rb') as ppd: 118 | for line in ppd: 119 | if "*NickName:" in line: 120 | model = line.split('"')[1] 121 | ppd.close() 122 | else: 123 | # Assume only a relative filename 124 | driver = os.path.join('/Library/Printers/PPDs/Contents/Resources', 125 | args.driver) 126 | with gzip.open(driver, 'rb') as ppd: 127 | for line in ppd: 128 | if "*NickName:" in line: 129 | model = line.split('"')[1] 130 | ppd.close() 131 | 132 | if '://' in args.address: 133 | # Assume the user passed in a full address and protocol 134 | address = args.address 135 | else: 136 | # Assume the user wants to use the default, socket:// 137 | address = 'socket://' + args.address 138 | 139 | if "wardsparadox" in args.identifier: 140 | profileidentifier = "com.github.wardsparadox.{0}".format(profileuuid) 141 | payloadidentifier = "com.github.wardsparadox.{0}".format(payloaduuid) 142 | else: 143 | profileidentifier = args.identifier 144 | payloadidentifier = "{0}.{1}".format(args.identifier, payloaduuid) 145 | 146 | if args.option: 147 | for option in args.option: 148 | item = option.split('=') 149 | _options[item[0]] = item[1] 150 | 151 | _options["printer-is-shared"] = False 152 | 153 | # Actual Printer Info 154 | Printer = {} 155 | _printer = {} 156 | _printer["DeviceURI"] = address 157 | _printer["DisplayName"] = displayName 158 | _printer["Location"] = location 159 | _printer["Model"] = model 160 | _printer["PPDURL"] = "file://localhost{0}".format(driver) 161 | _printer["PrinterLocked"] = False 162 | _printer["Option"] = _options 163 | Printer[printername] = _printer 164 | 165 | # Payload Content 166 | _payload = {} 167 | _payload["PayloadDisplayName"] = "Printing" 168 | _payload["PayloadEnabled"] = True 169 | _payload["PayloadIdentifier"] = payloadidentifier 170 | _payload["PayloadType"] = "com.apple.mcxprinting" 171 | _payload["PayloadUUID"] = payloaduuid 172 | _payload["PayloadVersion"] = 1 173 | _payload["UserPrinterList"] = Printer 174 | 175 | # Profile info 176 | _profile = {} 177 | _profile["PayloadDisplayName"] = "{0} Printer Profile {1}".format(displayName, version) 178 | _profile["PayloadIdentifier"] = profileidentifier 179 | _profile["PayloadOrganization"] = args.organization 180 | _profile["PayloadRemovalDisallowed"] = False 181 | _profile["PayloadScope"] = "System" 182 | _profile["PayloadType"] = "Configuration" 183 | _profile["PayloadUUID"] = profileuuid 184 | _profile["PayloadVersion"] = 1 185 | _profile["PayloadContent"] = [_payload] 186 | 187 | # Complete Profile 188 | Profile = _profile 189 | filename = "AddPrinter_{0}.mobileconfig".format(printername) 190 | scriptfilename = printername+"_uninstallscript.py" 191 | writePlist(Profile, filename) 192 | if args.munkiimport: 193 | munkiimport = "/usr/local/munki/munkiimport" 194 | try: 195 | if os.path.isfile(munkiimport): 196 | pass 197 | except Exception as e: 198 | raise "Munki Admin Tools Not Installed!" 199 | script = """#!/usr/bin/python 200 | from subprocess import call, check_output 201 | import os 202 | printertoremove = '{0}' 203 | for line in check_output(['/usr/bin/lpstat', '-a']).split(os.linesep)[:-1]: 204 | queuename = line.split()[0] 205 | printer = check_output(['/usr/bin/lpoptions', '-p', queuename]) 206 | if printertoremove in printer: 207 | print queuename, 'is printer needed to remove' 208 | print call(['/usr/sbin/lpadmin', '-x', queuename]) 209 | """.format(displayName) 210 | with open(scriptfilename, "w") as scriptfile: 211 | scriptfile.write(script) 212 | mi_cmd = [munkiimport, \ 213 | "--postuninstall_script={}".format(scriptfilename), \ 214 | "--postinstall_script={}".format(postinstall_script),\ 215 | filename] 216 | mi = subprocess.Popen(mi_cmd) 217 | mi.wait() 218 | scriptfile.close() 219 | yesno = raw_input("Remove Copy of Profile (and Script if used --munkiimport)? [y/n]") 220 | if yesno.startswith("y") or yesno.startswith("Y"): 221 | print "Removing files..." 222 | os.remove(os.path.join(cwd, scriptfilename)) 223 | os.remove(os.path.join(cwd, filename)) 224 | else: 225 | print "You will find the files in: %s" % cwd 226 | 227 | if __name__ == "__main__": 228 | main() 229 | --------------------------------------------------------------------------------