diff options
| -rw-r--r-- | .gitignore | 17 | ||||
| -rw-r--r-- | CONTRIBUTING.md | 29 | ||||
| -rw-r--r-- | LICENSE | 202 | ||||
| -rw-r--r-- | README.md | 9 | ||||
| -rw-r--r-- | Setup.hs | 17 | ||||
| -rw-r--r-- | src/Main.hs | 105 | ||||
| -rw-r--r-- | src/Pool.hs | 55 | ||||
| -rw-r--r-- | xscreensaver-dbus.cabal | 94 | ||||
| -rw-r--r-- | xscreensaver-dbus.service | 38 |
9 files changed, 566 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..fa10948 --- /dev/null +++ b/.gitignore @@ -0,0 +1,17 @@ +# Copyright 2020 Google LLC +# +# 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 +# +# https://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. + +.ghc.environment.* +cabal.project.local +dist* diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..22b241c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,29 @@ +# How to Contribute + +We'd love to accept your patches and contributions to this project. There are +just a few small guidelines you need to follow. + +## Contributor License Agreement + +Contributions to this project must be accompanied by a Contributor License +Agreement (CLA). You (or your employer) retain the copyright to your +contribution; this simply gives us permission to use and redistribute your +contributions as part of the project. Head over to +<https://cla.developers.google.com/> to see your current agreements on file or +to sign a new one. + +You generally only need to submit a CLA once, so if you've already submitted one +(even if it was for a different project), you probably don't need to do it +again. + +## Code reviews + +All submissions, including submissions by project members, require review. We +use GitHub pull requests for this purpose. Consult +[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more +information on using pull requests. + +## Community Guidelines + +This project follows +[Google's Open Source Community Guidelines](https://opensource.google/conduct/). @@ -0,0 +1,202 @@ + + 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 + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..c80466c --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +# xscreensaver-dbus + +xscreensaver-dbus implements the freedesktop.org D-Bus API for screensavers, +translating D-Bus calls into appropriate invocations of xscreensaver-command. +This allows D-Bus-compliant applications to interface with xscreensaver. + +Currently, xscreensaver-dbus only supports the [Idle Inhibition +Service](https://people.freedesktop.org/~hadess/idle-inhibition-spec/) +interface, but adding additional interfaces should be straightforward. diff --git a/Setup.hs b/Setup.hs new file mode 100644 index 0000000..6091805 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,17 @@ +-- Copyright 2020 Google LLC +-- +-- 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 +-- +-- https://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. + +import Distribution.Simple + +main = defaultMain diff --git a/src/Main.hs b/src/Main.hs new file mode 100644 index 0000000..dddc9ba --- /dev/null +++ b/src/Main.hs @@ -0,0 +1,105 @@ +-- Copyright 2020 Google LLC +-- +-- 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 +-- +-- https://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. + +{-# LANGUAGE OverloadedStrings #-} +module Main (main) where + +import Control.Concurrent (ThreadId, forkIO, killThread, threadDelay) +import Control.Concurrent.MVar ( MVar, modifyMVar, modifyMVar_, newMVar + , newEmptyMVar, putMVar, readMVar, takeMVar ) +import Control.Exception (assert) +import Control.Monad (forever, unless, void) +import Data.Maybe (fromJust, isJust, isNothing) +import qualified Data.Set as Set +import Data.Word (Word32) +import qualified DBus as D +import qualified DBus.Client as DC +import System.IO (hPutStrLn, stderr) +import System.Posix.Signals ( Handler(Catch), fullSignalSet, installHandler + , sigTERM, sigUSR1) +import qualified System.Process as Process + +import Pool (Pool) +import qualified Pool + +busName = "org.freedesktop.ScreenSaver" :: D.BusName +screensaverObjectPath = "/org/freedesktop/ScreenSaver" :: D.ObjectPath +screensaverInterfaceName = "org.freedesktop.ScreenSaver" :: D.InterfaceName + +wakeupSeconds = 10 :: Int + +type State = (Pool Word32, Maybe ThreadId) + +main :: IO () +main = do + -- Start with 0 as a reserved cookie value. The spec [1] doesn't say anything + -- about allowable cookie values, but Firefox uses the zero cookie value to + -- indicate “no cookie” [2]. Ensure that we never return a zero cookie to a + -- legitimate inhibition request. + -- + -- [1] https://people.freedesktop.org/~hadess/idle-inhibition-spec/index.html + -- [2] https://dxr.mozilla.org/mozilla-central/rev/a58462ad649eb95372a1665480505bdefc2b7531/widget/gtk/WakeLockListener.cpp#71 + state <- newMVar (Pool.withReserved (Set.singleton 0), Nothing) + -- Set up SIGUSR1 to dump state. + void $ installHandler sigUSR1 (Catch (showInfo state)) (Just fullSignalSet) + -- Connect to the bus and start listening. + client <- DC.connectSession + requestNameReply <- DC.requestName client busName [DC.nameDoNotQueue] + unless (requestNameReply == DC.NamePrimaryOwner) $ + error $ "unable to reserve bus name: " ++ show requestNameReply + DC.export client screensaverObjectPath + DC.defaultInterface + { DC.interfaceName = screensaverInterfaceName + , DC.interfaceMethods = + [ DC.autoMethod "Inhibit" (inhibit state) + , DC.autoMethod "UnInhibit" (uninhibit state) ] } + -- Wait for exit. Reference: + -- https://mail.haskell.org/pipermail/haskell-cafe/2010-May/077841.html + shouldExit <- newEmptyMVar + void $ installHandler sigTERM (Catch $ putMVar shouldExit ()) Nothing + takeMVar shouldExit + +inhibit :: MVar State -> String -> String -> IO Word32 +inhibit stateM _appname _reason = + modifyMVar stateM $ \(inhibitions, waker) -> do + let (cookie, inhibitions') = fromJust $ Pool.take inhibitions + waker' <- if Pool.null inhibitions + then assert (isNothing waker) $ + Just <$> forkIO wakerMain + else return waker + return ((inhibitions', waker'), cookie) + +uninhibit :: MVar State -> Word32 -> IO () +uninhibit stateM cookie = modifyMVar_ stateM $ \state@(inhibitions, waker) -> + case Pool.put cookie inhibitions of + Nothing -> return state + Just inhibitions' -> do + waker' <- if Pool.null inhibitions' + then do + assert (isJust waker) (killThread $ fromJust waker) + return Nothing + else return waker + return (inhibitions', waker') + +wakerMain :: IO () +wakerMain = forever $ do + Process.callProcess "xscreensaver-command" ["-deactivate"] + threadDelay $ wakeupSeconds * microsecondsPerSecond + +showInfo :: MVar State -> IO () +showInfo stateM = do + state <- readMVar stateM + hPutStrLn stderr $ show state + +microsecondsPerSecond = 1000 * 1000 :: Int diff --git a/src/Pool.hs b/src/Pool.hs new file mode 100644 index 0000000..8bb40eb --- /dev/null +++ b/src/Pool.hs @@ -0,0 +1,55 @@ +-- Copyright 2020 Google LLC +-- +-- 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 +-- +-- https://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. + +{-# OPTIONS_GHC -Wno-missing-import-lists #-} +module Pool + ( Pool + , empty, withReserved + , null + , take, put + ) where + +import Prelude hiding (null, take) + +import Control.Monad (guard) +import qualified Data.List as List +import Data.Set (Set) +import qualified Data.Set as Set + +data Pool a = Pool { reserved :: Set a, taken :: Set a } deriving (Eq, Show) + +empty :: Pool a +empty = withReserved Set.empty + +withReserved :: Set a -> Pool a +withReserved xs = Pool { reserved = xs, taken = Set.empty } + +null :: Pool a -> Bool +null p = Set.null (taken p) + +take :: (Bounded a, Enum a, Ord a) => Pool a -> Maybe (a, Pool a) +take p = do + x <- nextAvailable p + return (x, p { taken = Set.insert x (taken p) }) + +nextAvailable :: (Bounded a, Enum a, Ord a) => Pool a -> Maybe a +nextAvailable p = List.find (`Set.notMember` unavailable p) (enumFrom minBound) + +unavailable :: (Ord a) => Pool a -> Set a +unavailable p = reserved p `Set.union` taken p + +put :: Ord a => a -> Pool a -> Maybe (Pool a) +put x p = do + guard $ x `Set.member` taken p + return $ p { taken = Set.delete x (taken p) } diff --git a/xscreensaver-dbus.cabal b/xscreensaver-dbus.cabal new file mode 100644 index 0000000..b92d06f --- /dev/null +++ b/xscreensaver-dbus.cabal @@ -0,0 +1,94 @@ +-- Copyright 2020 Google LLC +-- +-- 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 +-- +-- https://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. + +cabal-version: >=2.0 +name: xscreensaver-dbus +version: 0.1.0 +synopsis: D-Bus adapter for xscreensaver +description: + xscreensaver-dbus implements the freedesktop.org D-Bus API for screensavers, + translating D-Bus calls into appropriate invocations of xscreensaver-command. + This allows D-Bus-compliant applications to interface with xscreensaver. +copyright: 2020 Google LLC +license: Apache-2.0 +license-file: LICENSE +author: Benjamin Barenblat +maintainer: bbaren@google.com +category: System +build-type: Simple +extra-source-files: CONTRIBUTING.md + , README.md + , xscreensaver-dbus.service + +executable xscreensaver-dbus + hs-source-dirs: src + default-language: Haskell2010 + other-extensions: OverloadedStrings + ghc-options: -Werror + -w + -- Enabled by default + -Wdeprecated-flags -Wwarn=deprecated-flags + -Wdeprecations -Wwarn=deprecations + -Wdodgy-foreign-imports + -Wduplicate-exports + -Wempty-enumerations + -Winline-rule-shadowing + -Wmissing-fields + -Wmissing-methods + -Woverflowed-literals + -Woverlapping-patterns + -Wredundant-constraints + -Wtabs + -Wunrecognised-pragmas -Wwarn=unrecognised-pragmas + -Wunrecognised-warning-flags -Wwarn=unrecognised-warning-flags + -Wunsupported-calling-conventions + -Wunsupported-llvm-version + -Wwarnings-deprecations -Wwarn=warnings-deprecations + -Wwrong-do-bind + -Wsimplifiable-class-constraints + -- Enabled by -W + -Wdodgy-exports + -Wdodgy-imports + -Wincomplete-patterns + -Wunbanged-strict-patterns + -Wunused-binds + -Wunused-foralls + -Wunused-imports + -Wunused-matches + -- Enabled by -Wall + -Wnoncanonical-monad-instances + -Wnoncanonical-monadfail-instances + -Wnoncanonical-monoid-instances + -Wmissing-monadfail-instances + -Wsemigroup + -Whi-shadowing + -Widentities + -Wincomplete-uni-patterns + -Wincomplete-record-updates + -Wmissing-export-lists + -Wmissing-import-lists + -Wmissing-exported-signatures + -Wmissing-pattern-synonym-signatures + -Wname-shadowing + -threaded + -rtsopts=none + -with-rtsopts=-I0 + -with-rtsopts=-V0 + main-is: Main.hs + other-modules: Pool + build-depends: base >=4.9 && <4.12 + , containers ^>=0.5.7.1 + , dbus ^>=1.0.1 + , process >=1.4.2 && <1.7 + , unix ^>=2.7.2 diff --git a/xscreensaver-dbus.service b/xscreensaver-dbus.service new file mode 100644 index 0000000..b710773 --- /dev/null +++ b/xscreensaver-dbus.service @@ -0,0 +1,38 @@ +# Copyright 2020 Google LLC +# +# 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 +# +# https://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. + +[Unit] +Description=xscreensaver-dbus D-Bus/XScreenSaver adapter + +[Service] +Type=dbus +BusName=org.freedesktop.ScreenSaver +ExecStart=%h/.local/bin/xscreensaver-dbus +NoNewPrivileges=true +KeyringMode=private +ProtectSystem=strict +ProtectHome=true +InaccessiblePaths=-/afs /boot -/lost+found /media /mnt /opt /proc /root /run /srv /sys /var +PrivateTmp=true +ProtectKernelTunables=true +ProtectControlGroups=true +RestrictNamespaces=true +LockPersonality=true +MemoryDenyWriteExecute=true +RestrictRealtime=true +RemoveIPC=true +SystemCallArchitectures=native + +[Install] +WantedBy=default.target |