1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747
|
#!/usr/bin/python3
# coding: utf-8
"""publish files on the internet"""
__epilog__ = """This program will upload the provided files on the
internet and notify the user when completed. The resulting URL will
also be copied to the clipboard. Preprocessors can do fancy things
before (only supports building an image gallery with sigal for
now). Options can be specified in the config file without the leading
dashes as well."""
# This is a (partial) rewrite of weasel's "publish" program. See the
# `parse_args` function for details on the behavior changes and
# variations.
# Copyright (C) 2020 Antoine Beaupré <anarcat@debian.org>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
import argparse
import atexit
from dataclasses import dataclass, astuple
from datetime import datetime, timedelta, timezone
import logging
import os.path
from pathlib import Path
import secrets # python 3.6
import shutil
from site import USER_BASE
import subprocess
import sys
import tempfile
from typing import (
Any,
Callable,
Iterable,
Iterator,
Literal,
Optional,
Sequence,
Tuple,
Type,
TypeVar,
Union,
)
try:
from typing import TypeAlias
except ImportError:
from typing_extensions import TypeAlias # Python 3.9 or earlier
from urllib.parse import quote
import yaml
try:
from shlex import join as shlex_join
except ImportError:
import shlex
# copied almost verbatim from python 3.8
#
# this triggers and error in mypy:
#
# error: All conditional function variants must have identical signatures [misc]
#
# couldn't trace it, so i silence it. original version has no type
# hints at all, and is nearly identical.
def shlex_join(split_command): # type: ignore[misc,no-untyped-def]
return " ".join(shlex.quote(arg) for arg in split_command)
# we need GTK's event loop (or, more precisely, its clipboard support)
# to hold on to the clipboard long enough for it to work, but fallback
# on xclip if GTK is unavailable.
try:
import gi # type: ignore
gi.require_version("Gtk", "3.0")
from gi.repository import GLib, Gtk, Gdk, GdkPixbuf # type: ignore
MessageDialog = Gtk.MessageDialog
except (ImportError, ValueError):
# "ValueError('Namespace %s not available' % namespace)"
gi = None
class MessageDialog: # type: ignore
pass
class LoggingAction(argparse.Action):
"""change log level on the fly
The logging system should be initialized before this, using
`basicConfig`.
"""
def __init__(self, *args, **kwargs): # type: ignore[no-untyped-def]
"""setup the action parameters
This enforces a selection of logging levels. It also checks if
const is provided, in which case we assume it's an argument
like `--verbose` or `--debug` without an argument.
"""
kwargs["choices"] = logging._nameToLevel.keys()
if "const" in kwargs:
kwargs["nargs"] = 0
super().__init__(*args, **kwargs)
def __call__(
self,
parser: argparse.ArgumentParser,
ns: argparse.Namespace,
values: Optional[Union[str, Sequence[Any]]],
option_string: Optional[str] = None,
) -> None:
"""if const was specified it means argument-less parameters"""
if self.const:
logging.getLogger("").setLevel(self.const)
else:
values = str(values)
if values not in logging.getLevelNamesMapping().keys():
parser.error("invalid logging level: %s" % values)
logging.getLogger("").setLevel(values)
# cargo-culted from _StoreConstAction
setattr(ns, self.dest, self.const or values)
class ConfigAction(argparse._StoreAction):
"""add configuration file to current defaults.
a *list* of default config files can be specified and will be
parsed when added by ConfigArgumentParser.
"""
def __init__(self, *args, **kwargs): # type: ignore[no-untyped-def]
"""the config action is a search path, so a list, so one or more argument"""
kwargs["nargs"] = 1
self._config_action_called = False
super().__init__(*args, **kwargs)
def __call__(
self,
parser: argparse.ArgumentParser,
ns: argparse.Namespace,
values: Optional[Union[str, Sequence[Any]]] = None,
option_string: Optional[str] = None,
) -> None:
"""change defaults for the namespace, still allows overriding
from commandline options"""
if self._config_action_called:
return
if values:
if not isinstance(values, Sequence):
values = [values]
saved_exception: Exception | None = None
for path in values:
try:
parser.set_defaults(**self.parse_config(path))
self._config_action_called = True
except OSError as e:
logging.debug("failed to load config file %s: %s", path, e)
saved_exception = e
except argparse.ArgumentError as e:
logging.warning("failed to parse config file %s: %s", path, e)
saved_exception = e
else:
# stop processing once we find a valid configuration
# file
break
else:
# re-raise failure if we really did not find any
# configuration file
if saved_exception:
raise saved_exception
super().__call__(parser, ns, values, option_string)
def parse_config(self, path: str) -> dict: # type: ignore[type-arg]
"""abstract implementation of config file parsing, should be overridden in subclasses
Parse errors should raise argparse.ArgumentError to report
parse errors as a usage error to the caller and leave OSError
to be raised, as they are expected and handled by the
ConfigArgumentParser.
"""
raise NotImplementedError()
class YamlConfigAction(ConfigAction):
"""YAML config file parser action"""
def parse_config(self, path: str) -> dict: # type: ignore[type-arg]
"""Raises YAML parse errors as argument errors."""
try:
with open(os.path.expanduser(path), "r") as handle:
logging.debug("parsing path %s as YAML" % path)
return yaml.safe_load(handle) or {}
except yaml.error.YAMLError as e:
raise argparse.ArgumentError(
self, "failed to parse YAML configuration: %s" % str(e)
)
class ConfigArgumentParser(argparse.ArgumentParser):
"""argument parser which supports parsing extra config files
Config files specified on the commandline through the
YamlConfigAction arguments modify the default values on the
spot. If a default is specified when adding an argument, it also
gets immediately loaded.
This will typically be used in a subclass, like this:
self.add_argument('--config', action=YamlConfigAction, default=self.default_config())
This shows how the configuration file overrides the default value
for an option:
>>> from tempfile import NamedTemporaryFile
>>> c = NamedTemporaryFile()
>>> c.write(b"foo: delayed\\n")
13
>>> c.flush()
>>> parser = ConfigArgumentParser()
>>> a = parser.add_argument('--foo', default='bar')
>>> a = parser.add_argument('--config', action=YamlConfigAction, default=[c.name])
>>> args = parser.parse_args([])
>>> args.config == [c.name]
True
>>> args.foo
'delayed'
>>> args = parser.parse_args(['--foo', 'quux'])
>>> args.foo
'quux'
This is the same test, but with `--config` called earlier, which
should still work:
>>> from tempfile import NamedTemporaryFile
>>> c = NamedTemporaryFile()
>>> c.write(b"foo: quux\\n")
10
>>> c.flush()
>>> parser = ConfigArgumentParser()
>>> a = parser.add_argument('--config', action=YamlConfigAction, default=[c.name])
>>> a = parser.add_argument('--foo', default='bar')
>>> args = parser.parse_args([])
>>> args.config == [c.name]
True
>>> args.foo
'quux'
>>> args = parser.parse_args(['--foo', 'baz'])
>>> args.foo
'baz'
This tests that you can override the config file defaults altogether:
>>> parser = ConfigArgumentParser()
>>> a = parser.add_argument('--config', action=YamlConfigAction, default=[c.name])
>>> a = parser.add_argument('--foo', default='bar')
>>> args = parser.parse_args(['--config', '/dev/null'])
>>> args.foo
'bar'
>>> args = parser.parse_args(['--config', '/dev/null', '--foo', 'baz'])
>>> args.foo
'baz'
This tests multiple search paths, first one should be loaded:
>>> from tempfile import NamedTemporaryFile
>>> d = NamedTemporaryFile()
>>> d.write(b"foo: argh\\n")
10
>>> d.flush()
>>> parser = ConfigArgumentParser()
>>> a = parser.add_argument('--config', action=YamlConfigAction, default=[d.name, c.name])
>>> a = parser.add_argument('--foo', default='bar')
>>> args = parser.parse_args([])
>>> args.foo
'argh'
>>> c.close()
>>> d.close()
There are actually many other implementations of this we might
want to consider instead of maintaining our own:
https://github.com/omni-us/jsonargparse
https://github.com/bw2/ConfigArgParse
https://github.com/omry/omegaconf
See this comment for a quick review:
https://github.com/borgbackup/borg/issues/6551#issuecomment-1094104453
"""
def parse_args( # type: ignore[override]
self,
args: Optional[Sequence[str]] = None,
namespace: Optional[argparse.Namespace] = None,
) -> argparse.Namespace:
# we do a first failsafe pass on the commandline to find out
# if we have any "config" parameters specified, in which case
# we must *not* load the default config file
try:
ns, _ = self.parse_known_args(args, namespace)
except OSError as e:
self.error("failed to parse configuration file: %s" % e)
# load the default configuration file, if relevant
#
# this will parse the specified config files and load the
# values as defaults *before* the rest of the commandline gets
# parsed
#
# we do this instead of just loading the config file in the
# namespace precisely to make it possible to override the
# configuration file settings on the commandline
for action in self._actions:
if not isinstance(action, ConfigAction) or action.default is None:
continue
if action.dest in ns and action.default != getattr(ns, action.dest):
# do not load config default if specified on the commandline
logging.debug("not loading default config because of --config override")
# action is already loaded, no need to parse it again
continue
try:
action(self, ns, action.default, None)
logging.debug("loaded config file: %s" % action.default)
except OSError as e:
# ignore errors from missing default config file
logging.debug("default config file %s error: %s" % (action.default, e))
# this will actually load the relevant config file when found
# on the commandline
#
# note that this will load the config file a second time
try:
return super().parse_args(args, namespace)
except OSError as e:
self.error("failed to parse configuration file: %s" % e)
def default_config(self) -> Iterable[str]:
"""handy shortcut to detect commonly used config paths
This list is processed as a FIFO: if a file is found in there,
it will be parsed and the remaining ones will be ignored.
"""
return [
os.path.join(
os.environ.get("XDG_CONFIG_HOME", "~/.config/"), self.prog + ".yml"
),
os.path.join(USER_BASE or "/usr/local", "etc", self.prog + ".yml"),
os.path.join("/usr/local/etc", self.prog + ".yml"),
os.path.join("/etc", self.prog + ".yml"),
]
class PubpasteArgumentParser(ConfigArgumentParser):
def __init__(self, *args, **kwargs): # type: ignore
"""
override constructor to setup our arguments and config file
"""
super().__init__(description=__doc__, epilog=__epilog__, add_help=False, *args, **kwargs) # type: ignore
# This is the usage of weasel's publish:
#
# usage: publish [<src> [<src> ...]]
#
# copy the file <src> to a server and report the URL.
#
# OPTIONS:
# -8 Add a AddDefaultCharset UTF-8 .htaccess file.
# -c CF Use config file CF.
# -H Show the history.
# -l Show last used token.
# -s FN When reading data from stdin, use FN as filename to be published.
# -S Make a screenshot of one window and publish.
# -h Show this message.
# -n no-do. Just print what would have been done.
# -q Produce a QR code.
# -r Add --relative option to rsync so that path names of the given
# files are preserved at the remote host.
# -t days time to live in days
# -R re-publish (re-use last directory token)
# -T tag directory name on the server (use this to re-publish under that name)
# -x Publish the contents of the xclipboard.
# -u Unpublish directory (only useful together with -T)
# -L Follow symlinks
self.add_argument("files", nargs="*", help="files to upload in default mode")
commands_group = self.add_argument_group(
"commands",
description="what should be done, default: upload the given files",
)
group = commands_group.add_mutually_exclusive_group()
group.add_argument(
"-x",
"--xselection",
action="store_const",
const="xselection",
dest="command",
help="publish the contents of the X PRIMARY selection",
)
group.add_argument(
"-C",
"--clipboard",
action="store_const",
const="xclipboard",
dest="command",
help="publish the contents of the X CLIPBOARD selection",
)
group.add_argument(
"-S",
"--screenshot",
action="store_const",
const="screenshot",
dest="command",
help="capture and upload a screenshot",
)
group.add_argument(
"-g",
"--gallery",
action="store_const",
const="gallery",
dest="command",
help="make a static image Sigal gallery from the files",
)
group.add_argument(
"-l",
"--last-token",
action="store_const",
const="last-token",
dest="command",
help="show the last token used and exit",
)
group.add_argument(
"-H",
"--show-history",
action="store_const",
const="show-history",
dest="command",
help="dump history file and exit",
)
group.add_argument(
"-u",
"--undo",
action="store_const",
const="undo",
dest="command",
help="delete uploaded token specified with -T or -R and exit",
)
group.add_argument(
"-P",
"--purge",
action="store_const",
const="purge",
dest="command",
help="purge old entries from remote server",
)
group.add_argument("--command", default="upload", help=argparse.SUPPRESS)
history_group = self.add_argument_group("history options")
history_group.add_argument(
"-t",
"--ttl",
help="how long to keep the entry, in days, default: %(default)s",
)
group = history_group.add_mutually_exclusive_group()
group.add_argument(
"-T", "--token", type=str, help="secret token, default: generated"
)
group.add_argument(
"-R", "--republish", action="store_true", help="reuse previous secret token"
)
config = self.add_argument_group("configuration options")
config.add_argument(
"-o",
"--output",
type=str,
help="rsync-compatible URL where to upload files, example: example.com:public_html/",
default=None,
)
config.add_argument(
"--url-prefix",
type=str,
help="how that output URL translates to a publicly visible URL, example: https://example.com/~user/",
default=None,
)
config.add_argument(
"--base-dir",
type=str,
help="local directory the output corresponds to, used in purge, example: /home/user/public_html/",
default=None,
)
config.add_argument(
"--save-screenshots",
type=str,
help="save a copy of screenshots in the given directory",
)
config.add_argument(
"--select",
action="store_true",
help="tell screenshot tool to let the user select an area, default: fullscreen",
)
options = self.add_argument_group("other options")
options.add_argument(
"-h",
"--help",
action="help",
default=argparse.SUPPRESS,
help="show this help message and exit",
)
options.add_argument(
"-v",
"--verbose",
action=LoggingAction,
const="INFO",
help="enable verbose messages",
)
options.add_argument(
"-d",
"--debug",
action=LoggingAction,
const="DEBUG",
help="enable debugging messages",
)
options.add_argument("--dryrun", "-n", action="store_true", help="do nothing")
options.add_argument(
"--follow-symlinks",
"-L",
action="store_true",
help="follow symlinks when copying files around",
)
options.add_argument(
"-r",
"--relative",
action="store_true",
help="consider all parts of the provided path, passed to rsync as --relative",
)
options.add_argument(
"-s",
"--stdin-name",
metavar="NAME",
default="stdin.txt",
type=str,
help="use NAME as filename when reading from stdin, default: %(default)s",
)
options.add_argument(
"--config",
action=YamlConfigAction,
default=self.default_config(),
help="use alternatte config file path, default: %(default)s",
)
def parse_args(self, *args, **kwargs): # type: ignore[no-untyped-def]
res = super().parse_args(*args, **kwargs)
if not res.output:
self.error("no --output location specified, aborting")
if not res.output.endswith("/"):
res.output += "/"
if res.url_prefix and not res.url_prefix.endswith("/"):
res.url_prefix += "/"
if res.dryrun:
if not res.files or "-" in res.files:
self.error("cannot read from stdin in dryrun")
if res.command in ("xselection", "xclipboard"):
self.error("cannot read from x selection in dryrun")
if res.files and res.command and res.command != "gallery":
self.error(
"command %s and files cannot be specified together" % res.command
)
if res.command and res.command == "purge" and res.base_dir is None:
self.error("no --base-dir specified, cannot find files to purge")
if res.command and res.command in ("xselection", "xclipboard") and res.relative:
# this is to workaround a bug where the tmpfile path gets
# propagated to the other side when using --relative
# https://gitlab.com/anarcat/pubpaste/-/issues/1
self.error("--relative and --xselection/--xclipboard do not make sense")
return res
class Processor(object):
def __init__(self, args: argparse.Namespace, dryrun: bool = False) -> None:
self.args = args
self.dryrun = dryrun
def process(self, paths: Iterable[Path], tmp_dir: str) -> Iterable[str]:
"""process the given paths
Returns the modified paths, or None if not modified. A tmp_dir
is provided by the caller and automatically destroyed.
"""
raise NotImplementedError()
class Sigal(Processor):
"""the Sigal processor will create a temporary gallery in the provided
tmp_dir, after copying the provided files in the said
directory. it returns only the "build" directory.
"""
def process(self, paths: Iterable[Path], tmp_dir: str) -> Iterable[str]:
output_dir = Path(tmp_dir) / Path(self.args.token)
if not output_dir.exists() and not self.dryrun:
logging.info("creating directory %s", output_dir)
output_dir.mkdir(parents=True)
pictures_dir = output_dir / "pictures"
if not pictures_dir.exists() and not self.dryrun:
logging.info("creating directory %s", pictures_dir)
pictures_dir.mkdir(parents=True)
# this removes the directory so that copytree works. this
# can be removed once we depend on Python 3.8, which has
# the `dirs_exist_ok` parameter
pictures_dir.rmdir()
conf_file = output_dir / "sigal.conf.py"
if not conf_file.exists() and not self.dryrun:
logging.info("creating config file %s", output_dir)
with conf_file.open("w") as c:
c.write(self.sigal_minimal_config())
for path in paths:
logging.info("copying %s into %s", path, pictures_dir)
if self.dryrun:
continue
try:
shutil.copytree(
path,
str(pictures_dir),
symlinks=not self.args.follow_symlinks,
ignore=shutil.ignore_patterns(".*"),
)
except NotADirectoryError:
logging.error(
"--gallery only works on directories, %s is not a directory", path
)
return []
build_dir = output_dir / "_build"
command = (
"sigal",
"build",
"--config",
str(conf_file),
str(pictures_dir),
str(build_dir),
)
logging.info("building gallery with %r", shlex_join(command))
if not self.dryrun:
subprocess.check_call(command)
return (str(build_dir),)
@classmethod
def sigal_minimal_config(cls) -> str:
"""a string representing a good minimal sigal configuration for our
use case.
sigal default settings are generally great, but i disagree on
those.
.. TODO:: allow users to provide their own config
"""
return """
# theme: colorbox (default), galleria, photoswipe, or path to custom
theme = 'galleria'
# sort files by date (default: filename)
medias_sort_attr = 'date'
# "Standard HD", or 720p (default: (640, 480))
img_size = (1280, 720)
# "Standard HD", or 720p (default: (480, 360))
video_size = (1280, 720)
# skip first three seconds in video (default: 0)
thumb_video_delay = '3'
"""
class TimerWindow(MessageDialog): # type: ignore[misc, valid-type]
"""This widget will show a timer and a spinner in a window for the
given delay, then close the dialog.
It's designed to be called with `run()`."""
DELAY = 3 # how long to wait, in seconds
def __init__(self, *args, **kwargs) -> None: # type: ignore[no-untyped-def]
super().__init__(title="Taking screenshot...")
mainBox = self.get_content_area()
self.spinner = Gtk.Spinner()
mainBox.pack_start(self.spinner, True, True, 0)
self.timeout_id = None
self.connect("destroy", self.clean_timers)
self.start_timer()
def clean_timers(self, *args) -> None: # type: ignore[no-untyped-def]
"""Ensure the timeout function is stopped"""
if self.timeout_id:
GLib.source_remove(self.timeout_id)
self.timeout_id = None
def on_timeout(self, *args, **kwargs) -> bool: # type: ignore[no-untyped-def]
"""A timeout function.
This is not a precise timer since next timeout
is recalculated based on the current time.
When this returns False, the timer is stopped.x"""
self.counter -= 1
if self.counter <= 0:
self.clean_timers()
self.spinner.stop()
self.response(False)
return False
elif self.counter < 4:
self.format_secondary_text("Say cheese!")
else:
self.format_secondary_text(
"Taking screenshot in " + str(int(self.counter / 4)) + " seconds!"
)
return True
def start_timer(self) -> None:
"""Start the timer
time out will check every 250 milliseconds (1/4 of a second),
so that the display is *approximately* accurate.
Since we're not telling the time here, it shouldn't matter
*too* much, but it looks better than rounded seconds,
presumably.
"""
self.counter = 4 * self.DELAY
self.format_secondary_text(
"Taking screenshot in " + str(int(self.counter / 4)) + " seconds!"
)
self.spinner.start()
self.timeout_id = GLib.timeout_add(250, self.on_timeout, None)
class ScreenshotProcessor(Processor):
def __init__(
self,
args: argparse.Namespace,
dryrun: bool = False,
save_screenshots: Optional[str] = None,
) -> None:
super().__init__(args, dryrun=dryrun)
self.select = args.select
self.save_screenshots = save_screenshots
def _select_paths(self, tmp_dir: str) -> Tuple[Path, Path]:
# build tempdir or use the assigned screenshot dir
if self.save_screenshots:
snaps_dir = Path(os.path.expanduser(self.save_screenshots))
if not snaps_dir.exists():
snaps_dir.mkdir()
else:
snaps_dir = Path(tmp_dir)
# set a the screenshot filename
snap_basename = Path(
"snap-" + datetime.now().strftime("%Y%m%dT%H%M%S%Z") + ".png"
)
target = Path(tmp_dir) / snap_basename
snap_path = snaps_dir / snap_basename
return snap_path, target
def gtk_wait_for_timeout(self) -> None:
timer = TimerWindow()
timer.show_all()
timer.run()
timer.destroy()
while Gtk.events_pending():
Gtk.main_iteration()
def gtk_confirm(self) -> bool:
mb = Gtk.MessageDialog()
mb.add_button("Yes", 0)
mb.add_button("No", 1)
mb.set_title("Upload screenshot publicly?")
mb.set_markup("Should we upload this screenshot publicly now?")
ret = bool(mb.run() == 0)
mb.destroy()
return ret
def confirm_upload(self, snap_path: Path, target: Path) -> Iterable[str]:
if self.gtk_confirm():
if not self.save_screenshots:
logging.debug("returning %s", target)
return (str(target),)
shutil.copy(str(snap_path), target)
# pass the resulting file back to the uploader
logging.info("screenshot copied from %s to %s", snap_path, target)
return (str(target),)
else:
logging.info("user declined, aborting")
return []
class Shotman(ScreenshotProcessor):
"""The shotman processor will take a screenshot and return the file."""
def process(self, paths: Iterable[Path], tmp_dir: str) -> Iterable[str]:
snap_path, target = self._select_paths(tmp_dir)
command = ["shotman", "--capture"]
# XXX: shotman doesn't support passing a specific area, for
# which we could then use slurp to select, then wait, then
# pass the region to shotman. since we can't do that, activate
# the timer only when we capture a whole output, since
# otherwise we have this weird effect of waiting for a
# timeout, then dropping to a selection
if self.select:
command.append("region")
else:
command.append("output")
self.gtk_wait_for_timeout()
if self.dryrun:
logging.warning("running in dry run, not taking screenshot")
return []
logging.info("taking screenshot with '%s'", shlex_join(command))
env = os.environ | {"XDG_SCREENSHOTS_DIR": str(snap_path.parent)}
success = subprocess.call(command, env=env) == 0
if not success:
notify_user("screenshot command failed, aborting")
return []
# find latest file in parent
#
# ideally, shotman would support a --file argument or show
# where it's saving files, but alas it isn't:
# https://todo.sr.ht/~whynothugo/shotman/35
# https://todo.sr.ht/~whynothugo/shotman/19
newest_path = None
for p in snap_path.parent.iterdir():
if newest_path is None:
newest_path = p
continue
if p.stat().st_mtime > newest_path.stat().st_mtime:
newest_path = p
continue
if newest_path is not None:
snap_path = newest_path
if not snap_path.exists():
notify_user("snapshot file missing, is maim installed?")
return []
if snap_path.stat().st_size <= 0:
notify_user("snapshot file is empty, aborting")
snap_path.unlink()
return []
return self.confirm_upload(snap_path, target)
class Grim(ScreenshotProcessor):
"""The Grim processor will take a screenshot and return the file after
copying it into a temporary directory.
An alternative to this is shotman, not in Debian:
https://git.sr.ht/~whynothugo/shotman
Another is grimshot, a shell script with interesting ideas like
pulling geometry from sway:
https://github.com/OctopusET/sway-contrib/blob/master/grimshot
"""
def process(self, paths: Iterable[Path], tmp_dir: str) -> Iterable[str]:
"""wrap grim around a timer, preview and prompt"""
snap_path, target = self._select_paths(tmp_dir)
if self.select:
logging.debug("selecting area with slurp")
select_pipe = subprocess.run(["slurp"], stdout=subprocess.PIPE, check=False)
if select_pipe.returncode != 0:
notify_user("selection aborted")
return []
command = [
"grim",
"-g",
select_pipe.stdout.strip().decode("ascii"),
str(snap_path),
]
else:
command = ["grim", str(snap_path)]
self.gtk_wait_for_timeout()
if self.dryrun:
logging.warning("running in dry run, not taking screenshot")
return []
logging.info("taking screenshot with '%s'", shlex_join(command))
success = subprocess.call(command) == 0
if not success:
notify_user("screenshot command failed, aborting")
return []
if not snap_path.exists():
notify_user("snapshot file missing, is maim installed?")
return []
if snap_path.stat().st_size <= 0:
notify_user("snapshot file is empty, aborting")
snap_path.unlink()
return []
# we delegate the customization of this to XDG
command = ["xdg-open", str(snap_path)]
logging.debug("opening image viewer with %s", command)
subprocess.Popen(command) # nowait
return self.confirm_upload(snap_path, target)
class Maim(ScreenshotProcessor):
"""The Main processor will take a screenshot and return the file after
copying it to the temporary directory"""
def __init__(
self,
args: argparse.Namespace,
dryrun: bool = False,
save_screenshots: Optional[str] = None,
) -> None:
super().__init__(args, dryrun=dryrun)
self.save_screenshots = save_screenshots
def process(self, paths: Iterable[Path], tmp_dir: str) -> Iterable[str]:
"""wrap main around a timer, preview and prompt"""
if self.select:
logging.debug("selecting area with slop")
select_pipe = subprocess.run(["slop"], stdout=subprocess.PIPE, check=False)
if select_pipe.returncode != 0:
notify_user("selection aborted")
return []
self.gtk_wait_for_timeout()
snap_path, target = self._select_paths(tmp_dir)
command = [
"maim",
"-g",
select_pipe.stdout.strip().decode("ascii"),
str(snap_path),
]
logging.info("taking screenshot with %s", shlex_join(command))
if not self.dryrun:
success = subprocess.call(command) == 0
if not success:
notify_user("screenshot command failed, aborting")
return []
if not snap_path.exists():
notify_user("snapshot file missing, is maim installed?")
return []
if snap_path.stat().st_size <= 0:
notify_user("snapshot file is empty, aborting")
snap_path.unlink()
return []
# we delegate the customization of this to XDG
command = ["xdg-open", str(snap_path)]
logging.debug("opening image viewer with %s", command)
subprocess.Popen(command) # nowait
return self.confirm_upload(snap_path, target)
class Uploader(object):
"""an abstract class to wrap around upload objects"""
def __init__(
self, target: str, dryrun: bool = False, follow_symlinks: bool = False
) -> None:
self.target = target
self.dryrun = dryrun
self.follow_symlinks = follow_symlinks
def upload(
self,
path: str,
target: Optional[str] = None,
single: Optional[bool] = False,
cwd: Optional[str] = None,
) -> bool:
"""upload the given path to the target
"Single" is an indication by the caller of whether or not this
is the only item in a list to upload.
"""
raise NotImplementedError()
class RsyncUploader(Uploader):
base_rsync_command: Tuple[str, ...] = (
"rsync",
"--recursive",
"--compress",
"--times",
"--chmod=u=rwX,go=rX",
)
def upload(
self,
path: str,
target: Optional[str] = None,
single: Optional[bool] = False,
cwd: Optional[str] = None,
) -> bool:
"""upload the given path to the target
"Single" is an indication by the caller of whether or not this
is the only item in a list to upload. The RsyncUploader uses
that information to decide how many levels it should replicate
remotely.
"""
if target is None:
target = self.target
command = list(self.base_rsync_command)
if self.follow_symlinks:
command.append("--copy-links") # -L
# XXX: begin nasty rsync commandline logic
# rsync is weird. it behaves differently when its arguments
# have trailing slashes or not. this specifically affects
# directory (but technically, if you pass a file with a
# trailing slash, it will fail, obviously)
#
# the behavior is documented in the manpage, as such:
# A trailing slash on the source changes this behavior to
# avoid creating an additional directory level at the
# destination. You can think of a trailing / on a source as
# meaning "copy the contents of this directory" as opposed to
# "copy the directory by name", but in both cases the
# attributes of the containing directory are transferred to
# the containing directory on the destination. In other words,
# each of the following commands copies the files in the same
# way, including their setting of the attributes of /dest/foo:
#
# rsync -av /src/foo /dest
# rsync -av /src/foo/ /dest/foo
# They omitted, obviously, that this is also identical:
#
# rsync -av /src/foo/ /dest/foo/
#
# So we pick the latter form, IF WE UPLOAD A SINGLE DIRECTORY!
# If we upload MULTIPLE FILES OR DIRECTORIES, we CANNOT use
# the above form, as the last uploads would overwrite the
# first ones. So if we have more than one file passed on the
# commandline, we do, effectively, this:
#
# rsync -av /srv/foo /srv/bar /dest/foo/
#
# which, yes, is actually equivalent to:
#
# rsync -av /srv/foo /dest/foo/foo
# rsync -av /srv/bar /dest/foo/bar
# so here we go.
# make sure we have a trailing slash at least to the
# second argument, so we are *certain* we upload in a new
# *directory*
if not target.endswith("/"):
target += "/"
# for the source, special handling if it is a directory
if os.path.isdir(path):
if single:
# single file to upload: upload at root which
# means, for rsync, to have a trailing slash
if not path.endswith("/"):
path += "/"
else:
# multiple files to upload: upload *within* the
# root, so *remove* the trailing slash if present
if path.endswith("/"):
path = path.rstrip("/")
# XXX: end nasty rsync commandline logic
command += (path, target)
logging.debug("uploading with %r", shlex_join(command))
if self.dryrun:
return self.dryrun
return subprocess.call(command, cwd=cwd) == 0
def delete(self, target: Optional[str] = None) -> bool:
"""delete the given target, or the one from the constructor
This is done by synchronizing it with an empty temporary
directory, and by calling rsync with `--delete`. We also
assert that the tmpdir is empty.
"""
if target is None:
target = self.target
with tempfile.TemporaryDirectory() as empty_dir:
assert not list(
Path(empty_dir).iterdir()
), "tmpdir is not empty, delete would fail"
command = list(self.base_rsync_command)
command.append("--delete")
command += (empty_dir + "/", target + "/")
logging.debug("deleting with %r", shlex_join(command))
if self.dryrun:
return self.dryrun
return subprocess.check_call(command) == 0
# we can't refer to History.Entry in History.Entry._make, see:
#
# https://stackoverflow.com/a/54534451/1174784
#
# this is fixed in PEP 673 (Python 3.11): https://peps.python.org/pep-0673/
EntryType = TypeVar("EntryType", bound="History.Entry")
class History:
TTL_PATH = ".publish.ttl"
@dataclass
class Entry:
date: str
time: str
token: str
uri: Optional[str] = None
@staticmethod
# we need to quote the type here because History.Entry is not defined yet
# and yep, that works.
def _make(line: str) -> "History.Entry":
items = line.strip().split(" ", 4)
return History.Entry(*items)
def __str__(self) -> str:
return " ".join(astuple(self))
def __init__(self, path: Optional[str] = None) -> None:
if path is None:
path = os.path.expanduser("~/.publish.history")
self.path = path
self.recorded = False
def append(self, token: str, uri: Optional[str]) -> None:
timestamp = datetime.now().strftime("%Y-%m-%d %H:%M:%S%Z")
with open(self.path, "a") as fp:
fp.write(" ".join((timestamp, token, uri or "")) + "\n")
def append_once(self, token: str, uri: Optional[str]) -> None:
if not self.recorded:
self.append(token, uri)
self.recorded = True
def remove(self, tokens: Iterable[str] = ()) -> None:
"""remove the given tokens from history"""
with open(self.path, "r") as old, open(self.path + ".new", "w") as new:
for line in old:
entry: History.Entry = History.Entry._make(line)
if entry.token not in tokens:
new.write(line)
os.rename(self.path + ".new", self.path)
def __iter__(self) -> Iterator[Entry]:
with open(self.path, "r") as fp:
for line in fp:
yield History.Entry._make(line)
def last(self) -> Optional[Entry]:
"""find last history token
This is separate from the above generator to avoid messing
with its state
"""
# date, time, token, uri
entry = None
line = None
with open(self.path, "r") as fp:
for line in fp:
pass
if line:
entry = History.Entry._make(line)
logging.debug("found last entry: %s", entry)
return entry
def purge(self, base_dir: str) -> None:
logging.debug("purging from %s", base_dir)
for path in [p for p in Path(base_dir).iterdir() if p.is_dir()]:
token = path.name
ttl_file = path / self.TTL_PATH
if not ttl_file.exists():
logging.info("no TTL file, token % never expires", token)
continue
with ttl_file.open("r") as fp:
ttl_str = fp.read()
try:
ttl = int(ttl_str)
except ValueError as e:
logging.warning(
"invalid TTL found for token %s: %s in %s", token, e, ttl_file
)
continue
now_utc = datetime.now(timezone.utc)
local_tz = now_utc.astimezone().tzinfo
last_modified = datetime.fromtimestamp(
ttl_file.stat().st_mtime, tz=local_tz
)
diff = timedelta(days=ttl)
logging.debug(
"time delta, last: %s, diff: %s days, last + diff: %s, delta: %s, now: %s",
last_modified,
diff,
last_modified + diff,
now_utc - last_modified + diff,
now_utc,
)
if last_modified + diff < now_utc:
notify_user(
"token %s expired since %s, removing directory: %s"
% (token, -(diff - (now_utc - last_modified)), path)
)
shutil.rmtree(path)
else:
logging.info(
"TTL %s days not passed yet (%s left) for token %s",
ttl,
diff - (now_utc - last_modified),
token,
)
def secret_token() -> Tuple[str, str]:
"""return a secret token made of multiple components, as a tuple"""
return datetime.now().strftime("%Y-%m-%d"), secrets.token_urlsafe()
SupportedExtensions: TypeAlias = Literal["png", "jpg", "txt", "html"]
class BaseClipboard:
def __init__(self, selection: Literal["CLIPBOARD", "PRIMARY"]) -> None:
"""configure the clipboard, based on whether the clipboard is PRIMARY
or CLIPBOARD
"""
self.selection = selection
def __str__(self) -> str:
return "%s(%s)" % (type(self).__name__, self.selection)
def put_text(self, text: str) -> bool:
raise NotImplementedError()
def put_image(self, path: bytes) -> bool:
raise NotImplementedError()
def get(self) -> Tuple[Optional[bytes], Optional[SupportedExtensions]]:
raise NotImplementedError()
# NOTE: we use xclip and gi directly here as the alternative is
# pyperclip, which does exactly the same thing:
#
# https://pypi.org/project/pyperclip/
#
# also, pyperclip actually *fails* to use gi in my tests, in Debian
# bullseye, so really, it's a lot of code for nothing for us. Worse,
# it doesn't support copying images the way we do.
class GtkClipboard(BaseClipboard):
"Clipboard implementation with a GTK/GI backend"
def __init__(self, selection: Literal["CLIPBOARD", "PRIMARY"]) -> None:
"""initialize a clipboard based on CLIPBOARD or PRIMARY selection
we use a string argument here to abstract away the GTK stuff"""
assert selection in ("CLIPBOARD", "PRIMARY"), "invalid clipboard selection used"
if selection == "CLIPBOARD":
self._cb = Gtk.Clipboard.get(Gdk.SELECTION_CLIPBOARD)
elif selection == "PRIMARY":
self._cb = Gtk.Clipboard.get(Gdk.SELECTION_PRIMARY)
logging.debug("created clipboard with %s selection", selection)
super().__init__(selection)
def _gdk_event_handler(self, event, user_data=None): # type: ignore[no-untyped-def]
logging.debug("event: %r, user_data: %r", event, user_data)
# pass the event to GTK so we actually send the paste back,
# and do whatever it is GTK does with events
# https://developer.gnome.org/pygtk/stable/gtk-functions.html#function-gtk--main-do-event
Gtk.main_do_event(event)
# this is xclip's behavior: when another process takes the
# selection, it exits
# https://developer.gnome.org/pygtk/stable/class-gdkevent.html#description-gdkevent
if event.type == Gdk.EventType.SELECTION_CLEAR:
logging.info("selection picked up by another process, exiting")
Gtk.main_quit()
def _wait_for_paste(self) -> None:
# add an event handler to exit early when something is pasted
# https://developer.gnome.org/gdk3/stable/gdk3-Events.html#gdk-event-handler-set
Gdk.event_handler_set(self._gdk_event_handler)
# Gtk won't process clipboard events unless we start
# Gtk.main(). Believe me, I tried.
Gtk.main()
def put_text(self, text: str) -> bool:
"""set the clipboard to the given text"""
def callback() -> None:
logging.debug("setting clipboard text to %r", text)
# NOTE: yes, it's silly that set_text() asks for the data
# length, this is python after all?
self._cb.set_text(text, len(text))
return self._put(callback)
def put_image(self, path: bytes) -> bool:
"""load the image from the given path name and put in the clipboard"""
def callback() -> None:
pixbuf = GdkPixbuf.Pixbuf.new_from_file(path)
logging.debug("setting clipboard image to %r", pixbuf)
self._cb.set_image(pixbuf)
return self._put(callback)
def _put(self, callback: Callable[[], None]) -> bool:
"""utility to do the actual paste, fork and wait for the paste to complete
This will just call the given callback, which is assumed to
have the data itself, either because it's a class method or
(easier) an inline function."""
pid = os.fork()
if pid: # parent
logging.info(
"forked child %d to hold onto clipboard data",
pid,
)
# TODO: use IPC to confirm paste with child
return True
else: # child
callback()
# TODO: this is where we would send success to parent
self._wait_for_paste()
# important, because we're in the child and otherwise we'd
# duplicate the parent's control flow
#
# we use _exit() to avoid firing atexit() in double
os._exit(0)
def get(self) -> Tuple[Optional[bytes], Optional[Literal["png", "txt"]]]:
"""get the clipboard content, possible as an image or, failing that, as text
GTK clipboards also support "rich text" and "URI", but I'm not
sure what to do with those. See:
https://developer.gnome.org/gtk3/3.24/gtk3-Clipboards.html#gtk-clipboard-wait-for-rich-text
https://developer.gnome.org/gtk3/3.24/gtk3-Clipboards.html#gtk-clipboard-wait-is-uris-available
https://python-gtk-3-tutorial.readthedocs.io/en/latest/clipboard.html
"""
if self._cb.wait_is_image_available():
data = self._cb.wait_for_image()
if data is None:
logging.warning("no clipboard content")
return None, None
res, imgdata = data.save_to_bufferv("png", [], [])
if not res:
logging.warning(
"could not parse clipboard data (%d bytes) as image, ignoring",
len(data),
)
return None, None
logging.debug("found %d bytes of image data in clipboard", len(imgdata))
return imgdata, "png"
elif self._cb.wait_is_text_available():
# https://developer.gnome.org/gtk3/3.24/gtk3-Clipboards.html#gtk-clipboard-wait-for-text
# https://stackoverflow.com/questions/13207897/how-to-get-clipboard-content-in-gtk3-gi-and-python-3-on-ubuntu
data = self._cb.wait_for_text()
if data is None:
logging.warning("no clipboard content")
return None, None
logging.debug("found %d bytes of text data in clipboard", len(data))
return data.encode("utf-8"), "txt"
else:
logging.warning("unsupported clipboard type")
return None, None
class WaylandClipboard(BaseClipboard):
def __init__(self, selection: Literal["CLIPBOARD", "PRIMARY"]) -> None:
self.extra = []
if selection == "PRIMARY":
self.extra = ["--primary"]
super().__init__(selection)
def put_text(self, text: str) -> bool:
return self._put_data(text.encode("utf-8"))
def put_image(self, data: bytes) -> bool:
return self._put_data(data)
def _put_data(self, data: bytes) -> bool:
command = ["wl-copy"] + self.extra
logging.debug("sending %d bytes to %s", len(data), command)
p = subprocess.Popen(command, stdin=subprocess.PIPE)
p.communicate(data)
if p.returncode == 0:
return True
else:
logging.warning("could not copy to clipboard with: %r", command)
return False
def get(self) -> Tuple[Optional[bytes], Optional[SupportedExtensions]]:
command = ["wl-paste", "--list-types"] + self.extra
logging.debug("listing supported types with %s", command)
mimetype_output = subprocess.run(command, stdout=subprocess.PIPE)
mimetypes = mimetype_output.stdout.decode("ascii").split("\n")
extension: Optional[SupportedExtensions] = None
if mimetypes == ["No selection"]:
return None, None
if "image/png" in mimetypes:
extension = "png"
mimetype = "image/png"
elif "image/jpeg" in mimetypes:
extension = "jpg"
mimetype = "image/jpeg"
elif "text/html" in mimetypes:
extension = "html"
mimetype = "text/html"
elif "text/plain;charset=utf-8" in mimetypes:
extension = "txt"
mimetype = "text/plain;charset=utf-8"
elif "text/plain" in mimetypes:
extension = "txt"
mimetype = "text/plain"
else:
logging.warning("unsupported clipboard mimetypes: %s", mimetypes)
return None, None
command = ["wl-paste", "--type", mimetype] + self.extra
logging.debug("extracting data with %s", command)
data = subprocess.run(command, stdout=subprocess.PIPE).stdout
return data, extension
# TODO: xsel support? might be hard because it relies on a clipboard
# manager (e.g. xclipboard(1)) to store the selection for us, which we
# can't rely on... The equivalent in GTK is the `store()` command,
# which didn't work in my environment (i3 minimal desktop).
class XclipClipboard(BaseClipboard):
def __init__(self, selection: Literal["CLIPBOARD", "PRIMARY"]) -> None:
assert selection in ("CLIPBOARD", "PRIMARY"), "invalid clipboard selection used"
self.command = ("xclip", "-selection", selection.lower())
super().__init__(selection)
def put_text(self, text: str) -> bool:
if not os.environ.get("DISPLAY"):
logging.warning("could not copy to clipboard without a DISPLAY variable")
return False
logging.debug("copying clipboard with: %s", self.command)
p = subprocess.Popen(self.command, stdin=subprocess.PIPE)
p.communicate(text.encode("utf-8"))
if p.returncode == 0:
return True
else:
logging.warning("could not copy to clipboard with: %r", self.command)
return False
def put_image(self, data: bytes) -> bool:
raise NotImplementedError("xclip does not support copying images")
def get(self) -> Tuple[Optional[bytes], Optional[Literal["png", "txt"]]]:
command = list(self.command) + ["-o"]
logging.debug("pasting clipboard with: %s", self.command)
try:
clipboard = subprocess.check_output(command)
except (FileNotFoundError, subprocess.CalledProcessError) as e:
logging.error("could not find tool to paste clipboard: %s", e)
return None, None
return clipboard, "txt"
def in_wayland() -> bool:
return bool(
os.environ.get("XDG_SESSION_TYPE", "xorg") == "wayland"
or os.environ.get("WAYLAND_DISPLAY")
)
if in_wayland():
Clipboard: Type[BaseClipboard] = WaylandClipboard
elif gi:
Clipboard = GtkClipboard
else:
Clipboard = XclipClipboard
def notify_user(message: str) -> None:
logging.warning(message)
if os.environ.get("DISPLAY") is None:
return
command = ("notify-send", message)
# do not fail on notifications
logging.debug("running %s", command)
try:
subprocess.run(command, check=True)
except (subprocess.CalledProcessError, OSError) as e:
logging.warning(
"failed to run command %s, ignoring: %s", shlex_join(command), e
)
def main() -> None:
"""
This program does the following:
1. dispatch history commands: purge, show-history or last-token
2. prepare the token from history or generate one
3. guess the URL of the resulting paste
4. dispatch the various commands
5. write the TTL file to eventually expire this paste
6. upload resulting files
7. add the guesed URL to the clipboard
8. notify the user, probably with notify-send
"""
logging.basicConfig(format="%(message)s", level="WARNING")
args = PubpasteArgumentParser().parse_args() # type: ignore[no-untyped-call]
history = History()
# 1. dispatch history commands like show-history or last-token
if args.command == "show-history":
for entry in history:
print(entry)
sys.exit(0)
elif args.command == "last-token":
last = history.last()
if last:
print(last.token)
sys.exit(0)
else:
sys.exit(1)
elif args.command == "purge":
history.purge(args.base_dir)
sys.exit(0)
# 2. prepare the token
# ... from history (if --republish, which is implicit with --undo)
if args.republish or args.command == "undo":
last = history.last()
# do not override provided token
if last and not args.token:
args.token = last.token
# ... no token provided, generate a new one
if args.token is None:
args.token = "-".join(secret_token())
logging.debug("using secret token %s", args.token)
# 3. guess the URL of the resulting paste
#
# user has a public facing URL for publishing, generate the
# resulting URL for this paste
if args.url_prefix:
assert args.url_prefix.endswith(
"/"
), "args parsing should have ensured a trailing slash"
uri_with_token = args.url_prefix + args.token + "/"
else:
uri_with_token = None
# files that we are confident we can show the user on the
# terminal. those are typically stdin and xselection but could
# grow to include text files..
dump_content = []
# prepare our uploader object
uploader = RsyncUploader(
target=args.output + args.token, follow_symlinks=args.follow_symlinks
)
if logging.getLogger("").level >= 20: # INFO or DEBUG
uploader.base_rsync_command += ("--progress", "--verbose")
if args.relative:
uploader.base_rsync_command += ("--relative",)
# list of cleanup functions to run after upload
if not args.dryrun:
tmp_dir = tempfile.TemporaryDirectory()
atexit.register(tmp_dir.cleanup)
# 4. dispatch the various commands
#
# main command dispatcher, a block may just exit here if it does
# all its work, or it may change args.files to add more files to
# the upload queue
if args.command == "undo":
if not uploader.delete():
notify_user("failed to delete target %s" % args.token)
sys.exit(1)
history.remove(args.token)
notify_user("deleted target %s" % args.token)
sys.exit(0)
elif args.command in ("xselection", "xclipboard"):
clipboard_primary = Clipboard(
"PRIMARY" if args.command == "xselection" else "CLIPBOARD"
)
logging.info("reading from xselection with %s...", clipboard_primary)
data, extension = clipboard_primary.get()
if data is None:
logging.error("no clipboard data found, aborting")
sys.exit(1)
assert extension is not None, "clipboard should have guess extension"
# NOTE: could this be optimized? can we *stream* the
# clipboard?
clipboard_tmp_path = Path(tmp_dir.name) / ("clipboard." + extension)
clipboard_tmp_path.write_bytes(data)
logging.info(
"written %d bytes from clipboard into %s", len(data), clipboard_tmp_path
)
args.files = [str(clipboard_tmp_path)]
if extension == "txt":
dump_content = [str(clipboard_tmp_path)]
elif args.command == "screenshot":
if in_wayland():
logging.info("running under Wayland, trying screenshot with Grim")
args.files = Grim(
args, dryrun=args.dryrun, save_screenshots=args.save_screenshots
).process([], tmp_dir.name)
else: # Xorg case
logging.info("running under Xorg, trying screenshot with Maim")
args.files = Maim(
args, dryrun=args.dryrun, save_screenshots=args.save_screenshots
).process([], tmp_dir.name)
elif args.command == "gallery":
logging.debug("processing files %s with Sigal", args.files)
f = Sigal(args, dryrun=args.dryrun).process(args.files, tmp_dir.name)
if f is not None:
args.files = f
logging.debug("modified files: %s", args.files)
elif not args.files:
# default to stdin
args.files = ["-"]
if not args.output:
logging.error("no output provided, nothing to do, aborting")
sys.exit(1)
# this should never be reached, but just in case
if not args.files:
logging.error("no files provided, nothing to do, aborting")
sys.exit(1)
# 5. write the TTL file to eventually expire this paste
#
# we do this before the upload to make sure uploads are expired
# even if they fail or are interrupted half-way through
if args.ttl:
# use a separate tmpdir to avoid uploading the ttl file twice
with tempfile.TemporaryDirectory() as ttl_tmp_dir:
ttl_file = ttl_tmp_dir + "/" + history.TTL_PATH
if not args.dryrun:
Path(ttl_file).write_text(args.ttl + "\n")
if not uploader.upload(history.TTL_PATH, cwd=ttl_tmp_dir):
notify_user("failed to upload TTL file for %s" % args.token)
# 6. upload resulting files
#
# main upload loop, files either from the commandline or previous
# dispatchers
for key, path in enumerate(args.files):
# generate a new URI *specific to this file*
uri = None
if uri_with_token:
uri = uri_with_token
if not os.path.isdir(path):
uri += quote(path)
# process "-" specially
cwd = None
if path == "-":
logging.info("reading from stdin...")
stdin_tmp_path = tmp_dir.name + "/" + args.stdin_name
cwd = tmp_dir.name
path = args.stdin_name
args.files[key] = path
with open(stdin_tmp_path, "w+b") as tmp:
shutil.copyfileobj(sys.stdin.buffer, tmp)
dump_content = [stdin_tmp_path]
if uri_with_token:
uri = uri_with_token + quote(path)
# dump file contents we know is terminal-safe
if path in dump_content:
with open(path, "rb") as fp:
print("uploading content: %r" % bytes(fp.read()))
assert args.output.endswith("/")
# record history
history.append_once(args.token, uri_with_token or None)
if uri:
logging.info("uploading %s to %s", path, uri)
else:
logging.info("uploading %s", path)
# actual upload
if not uploader.upload(path, single=(len(args.files) == 1), cwd=cwd):
notify_user("failed to upload %s as %s, aborting" % (path, args.token))
sys.exit(1)
# if we don't have a URI to announce, we're done
if not uri_with_token:
notify_user("uploaded %s" % shlex_join(args.files))
sys.exit(0)
uri = uri_with_token
# if we've processed a single file, add it to the announced URL
if len(args.files) == 1:
path = Path(args.files[0])
if not path.is_dir():
uri += quote(os.path.basename(path))
# 7. add the guesed URL to the clipboard
selection_clipboard = Clipboard("CLIPBOARD")
pasted = selection_clipboard.put_text(uri)
# 8. notify the user, probably with notify-send
message = "uploaded %s to '%s'" % (shlex_join(args.files), uri)
if pasted:
message += " copied to clipboard"
if args.ttl:
message += ", expiring in %s days" % args.ttl
else:
message += ", never expiring"
notify_user(message)
if __name__ == "__main__":
try:
main()
except KeyboardInterrupt:
logging.warning("interrupted, aborting")
|