Repository: abiyani/automate-save-page-as Branch: master Commit: 53570667380f Files: 3 Total size: 22.3 KB Directory structure: gitextract_t1gnvbey/ ├── LICENSE ├── README.md └── save_page_as ================================================ FILE CONTENTS ================================================ ================================================ FILE: LICENSE ================================================ Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS Copyright 2015 Anurag Biyani Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ================================================ FILE: README.md ================================================ automate-save-page-as ===================== *A quick hack for when `wget` doesn't cut it.* **tl;dr Perform browser's "Save page as" (Ctrl+S) operation from command line without manual intervention** ![Demo](demo.gif) This small bash script *simulates* a sequence of key presses which opens a given url in the browser, save the page (Ctrl+S), and close the browser tab/window (Ctrl+F4). Chained together, these operations allow you to use the "Save Page As" (Ctrl+S) programtically (currently you can use either of `google-chrome`, `chromium-browser` or `firefox`, and it's fairly straight forward to add support for your favorite browser). *Examples:* ``` # Save your FB home page $ ./save_page_as "www.facebook.com" --destination "/tmp/facebook_home_page.html" ``` ``` # Use Firefox to open a web-page and save it in /tmp (the default name for the file (Page title) is used) $ ./save_page_as "www.example.com" --browser "firefox" --destination "/tmp" ``` ``` # Save a url with default name, but provide an additional suffix $ ./save_page_as "www.example.com" --destination "/tmp" --suffix "-trial_save" ``` ``` # List all available command line options. $ ./save_page_as --help save_page_as: Open the given url in a browser tab/window, perform 'Save As' operation and close the tab/window. USAGE: save_page_as URL [OPTIONS] URL The url of the web page to be saved. options: -d, --destination Destination path. If a directory, then file is saved with default name inside the directory, else assumed to be full path of target file. Default = '.' -s, --suffix An optional suffix string for the target file name (ignored if --destination arg is a full path) -b, --browser Browser executable to be used (must be one of 'google-chrome' or 'firefox'). Default = 'google-chrome'. --load-wait-time Number of seconds to wait for the page to be loaded (i.e., seconds to sleep before Ctrl+S is 'pressed'). Default = 4 --save-wait-time Number of seconds to wait for the page to be saved (i.e., seconds to sleep before Ctrl+F4 is 'pressed'). Default = 8 -h, --help Display this help message and exit. ``` The script needs `xdotool` installed (http://www.semicomplete.com/projects/xdotool/): `sudo apt-get install xdotool` (for Ubuntu). *Sidenote*: My particular use case while writing this script was crawling a bunch of web pages which were rendered almost entierly on client side using lots of javascript magic (thus saving output of `wget url` was useless). Since the browser is capable of rendering those pages, and also saving the post-render version on disk (using Ctrl+S), I wrote this script to automate the process (Tested on Ubuntu 12.04 and 14.04 myself). Suggestions and/or pull requests are always welcome! ================================================ FILE: save_page_as ================================================ #!/bin/bash set -e set -u set -o pipefail # Assert existence of xdotool to begin with if ! xdotool --help &>/dev/null; then printf "ERROR: 'xdotool' is not present (or not in the PATH). Please visit http://www.semicomplete.com/projects/xdotool/ to download it for your platform.\n" >&2 exit 1 fi load_wait_time=4 save_wait_time=8 scriptname="$(basename "$0")" destination="." browser="google-chrome" suffix="" url="" function print_usage() { printf "\n%s: Open the given url in a browser tab/window, perform 'Save As' operation and close the tab/window.\n\n" "${scriptname}" >&2 printf "USAGE:\n %s URL [OPTIONS]\n\n" "${scriptname}" >&2 printf "URL The url of the web page to be saved.\n\n" >&2 printf "options:\n" >&2 printf " -d, --destination Destination path. If a directory, then file is saved with default name inside the directory, else assumed to be full path of target file. Default = '%s'\n" "${destination}" >&2 printf " -s, --suffix An optional suffix string for the target file name (ignored if --destination arg is a full path)\n" >&2 printf " -b, --browser Browser executable to be used (must be one of 'google-chrome', 'chromium-browser' or 'firefox'). Default = '%s'.\n" "${browser}" >&2 printf " --load-wait-time Number of seconds to wait for the page to be loaded (i.e., seconds to sleep before Ctrl+S is 'pressed'). Default = %s\n" "${load_wait_time}" >&2 printf " --save-wait-time Number of seconds to wait for the page to be saved (i.e., seconds to sleep before Ctrl+F4 is 'pressed'). Default = %s\n" "${save_wait_time}" >&2 printf " -h, --help Display this help message and exit.\n" >&2 } while [ "$#" -gt 0 ] do case "$1" in -d | --destination) shift; destination="$1" shift ;; -s | --suffix) shift; suffix="$1" shift; ;; -b | --browser) shift; browser="$1" shift ;; --load-wait-time) shift; load_wait_time="$1" shift ;; --save-wait-time) shift; save_wait_time="$1" shift ;; -h | --help) print_usage exit 0 ;; -*) printf "ERROR: Unknown option: %s\n" "${1}">&2 print_usage exit 1 ;; *) if [ ! -z "$url" ]; then printf "ERROR: Expected exactly one positional argument (URL) to be present, but encountered a second one ('%s').\n\n" "${1}" >&2 print_usage exit 1 fi url="$1" shift; ;; esac done # Returns 1 if input param contains any non-printable or non-ascii character, else returns 0 # (Inspiration: http://stackoverflow.com/a/13596664/1857518) function has_non_printable_or_non_ascii() { LANG=C if printf "%s" "${1}" | grep '[^ -~]\+' &>/dev/null; then printf 1 else printf 0 fi } function validate_input() { if [[ -z "${url}" ]]; then printf "ERROR: URL must be specified." >&2 print_usage exit 1 fi if [[ -d "${destination}" ]]; then printf "INFO: The specified destination ('%s') is a directory path, will save file inside it with the default name.\n" "${destination}">&2 else local basedir="$(dirname "${destination}")" if [[ ! -d "${basedir}" ]]; then printf "ERROR: Directory '%s' does not exist - Will NOT continue.\n" "${basedir}" >&2 exit 1 fi fi destination="$(readlink -f "$destination")" # Ensure absolute path if [[ "${browser}" != "google-chrome" && "${browser}" != "chromium-browser" && "${browser}" != "firefox" ]]; then printf "ERROR: Browser (%s) is not supported, must be one of 'google-chrome', 'chromium-browser' or 'firefox'.\n" "${browser}" >&2 exit 1 fi if ! command -v "${browser}" &>/dev/null; then printf "ERROR: Command '${browser}' not found. Make sure it is installed, and in path.\n" >&2 exit 1 fi local num_regexp='^.[0-9]+$|^[0-9]+$|^[0-9]+.[0-9]+$' # Matches a valid number (in decimal notation) if [[ ! "${load_wait_time}" =~ $num_regexp || ! "${save_wait_time}" =~ $num_regexp ]]; then printf "ERROR: --load-wait-time (='%s'), and --save_wait_time(='%s') must be valid numbers.\n" "${load_wait_time}" "${load_wait_time}" >&2 exit 1 fi if [[ $(has_non_printable_or_non_ascii "${destination}") -eq 1 || $(has_non_printable_or_non_ascii "${suffix}") -eq 1 ]]; then printf "ERROR: Either --destination ('%s') or --suffix ('%s') contains a non ascii or non-printable ascii character(s). " "${destination}" "${suffix}" >&2 printf "'xdotool' does not mingle well with non-ascii characters (https://code.google.com/p/semicomplete/issues/detail?id=14).\n\n" >&2 printf '!!!! Will NOT proceed !!!!\n' >&2 exit 1 fi } validate_input ############## # Launch ${browser}, and wait for the page to load "${browser}" "${url}" &>/dev/null & sleep ${load_wait_time} # Find the id for the ${browser} window browser_wid="$(xdotool search --sync --onlyvisible --class "${browser}" | head -n 1)" wid_re='^[0-9]+$' # window-id must be a valid integer if [[ ! "${browser_wid}" =~ ${wid_re} ]]; then printf "ERROR: Unable to find X-server window id for browser.\n" >&2 exit 1 fi # Activate the ${browser} window, and "press" ctrl+s xdotool windowactivate "${browser_wid}" key --clearmodifiers "ctrl+s" sleep 1 # Give 'Save as' dialog box time to show up # Resolve the expected title name for save file dialog box (chrome & firefox differ in this regard) if [[ "${browser}" == "firefox" ]]; then savefile_dialog_title="Save as" else savefile_dialog_title="Save file" fi # Find window id for the "Save file" dialog box savefile_wid="$(xdotool search --name "$savefile_dialog_title" | head -n 1)" if [[ ! "${savefile_wid}" =~ ${wid_re} ]]; then printf "ERROR: Unable to find window id for 'Save File' Dialog.\n" >&2 exit 1 fi # Fix for Issue #1: Explicitly focus on the "name" field (works on both: gnome, and kde) xdotool windowactivate "${savefile_wid}" key --delay 20 --clearmodifier "Alt+n" # Check if we are using kde is_kde=0 # Don't feel bad if DESKTOP_SESSION env variable is not present set +u if [[ "${DESKTOP_SESSION}" =~ ^kde-? ]]; then is_kde=1 fi set -u if [[ ! -z "${suffix}" ]]; then ########################### # Make sure that we are at correct position before typing the "suffix" # # If the user is using 'kde-plasma', then the full name of the file including the extension is highlighted # in the name field, so simply pressing a Right key and adding suffix leads to incorrect result. # Hence as a special case for 'kde-*' we move back 5 characters Left from the end before adding the suffix. # Now this strategy is certainly not full proof and assumes that file extension is always 4 characters long ('html'), # but this is the only fix I can think for this special case right now. Of course it's easy to tweak the number of # Left key moves you need if you know your file types in advance. if [[ "${is_kde}" -eq 1 ]]; then printf "INFO: Desktop session is found to be '${DESKTOP_SESSION}', hence the full file name will be highlighted. " >&2 printf "Assuming extension .html to move back 5 character left before adding suffix (change accordingly if you need to).\n" >&2 xdotool windowactivate "${savefile_wid}" key --delay 40 --clearmodifier End Left Left Left Left Left else xdotool windowactivate "${savefile_wid}" key --delay 20 --clearmodifiers Right fi set -u ########################### extraarg="" if [[ "${suffix::1}}" == "-" ]]; then extraarg="-" fi xdotool type --delay 10 --clearmodifiers "${extraarg}" "${suffix}" fi # Activate the 'Save File' dialog and type in the appropriate filename (depending on ${destination} value: 1) directory, 2) full path, 3) empty) if [[ ! -z "${destination}" ]]; then if [[ -d "${destination}" ]]; then # Case 1: --destination was a directory. xdotool windowactivate "${savefile_wid}" key --delay 20 --clearmodifiers Home xdotool type --delay 10 --clearmodifiers "${destination}/" else # Case 2: --destination was full path. xdotool windowactivate "${savefile_wid}" key --delay 20 --clearmodifiers "ctrl+a" "BackSpace" xdotool type --delay 10 --clearmodifiers "${destination}" fi fi xdotool windowactivate "${savefile_wid}" key --delay 20 --clearmodifiers Return printf "INFO: Saving web page ...\n" >&2 # Wait for the file to be completely saved sleep ${save_wait_time} # Close the browser tab/window (Ctrl+w for KDE, Ctrl+F4 otherwise) if [[ "${is_kde}" -eq 1 ]]; then xdotool windowactivate "${browser_wid}" key --clearmodifiers "ctrl+w" else xdotool windowactivate "${browser_wid}" key --clearmodifiers "ctrl+F4" fi printf "INFO: Done!\n">&2