New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add extension for Do Not Disturb Mode (and underlay User Preference extension) #1706

Closed

waynezhang wants to merge 4 commits into Hammerspoon:master from waynezhang:master

Contributor

waynezhang commented Mar 15, 2018 •

edited

Loading

Add a new extension to control Do Not Disturb Mode

-- Get current value
local status = hs.donotdisturb.status()

-- Turn on  Do Not Disturb Mode
hs.donotdisturb.on()

-- Turn off  Do Not Disturb Mode
hs.donotdisturb.off()

And because it's depended on user preference, I also isolated it as a standalone extension

-- Set preference
hs.userpreferences.set("key", value, "application id")

-- Get preference
hs.userpreferences.get("key", "application id")

-- Synchronize preferences
hs.userpreferences.sync("application id")

stickler-ci reviewed

View reviewed changes

extensions/notdisturbmode/test_notdisturbmode.lua Outdated

		@@ -0,0 +1,17 @@
		hs.notdisturbmode = require("hs.notdisturbmode")

		function testNotDisturbMode()

stickler-ci Mar 15, 2018

(W111) setting non-standard global variable 'testNotDisturbMode'

extensions/notdisturbmode/test_notdisturbmode.lua Outdated

+                local isOn =  hs.notdisturbmode.status()
+                hs.notdisturbmode.off()
+                assertIsEqual(false, hs.notdisturbmode.status())

stickler-ci Mar 15, 2018

(W113) accessing undefined variable 'assertIsEqual'

extensions/notdisturbmode/test_notdisturbmode.lua Outdated

+                assertIsEqual(false, hs.notdisturbmode.status())
+                hs.notdisturbmode.on()
+                assertIsEqual(true, hs.notdisturbmode.status())

stickler-ci Mar 15, 2018

(W113) accessing undefined variable 'assertIsEqual'

extensions/notdisturbmode/test_notdisturbmode.lua Outdated

+                  hs.notdisturbmode.off()
+                end
+                return success()

stickler-ci Mar 15, 2018

(W113) accessing undefined variable 'success'

extensions/userpreference/test_userpreference.lua Outdated

		@@ -0,0 +1,25 @@
		hs.userpreference = require("hs.userpreference")

		function testUserPreference()

stickler-ci Mar 15, 2018

(W111) setting non-standard global variable 'testUserPreference'

extensions/userpreference/test_userpreference.lua Outdated

+                hs.userpreference.set("test_user_preference", false, "com.hammerspoon.hammerspoon")
+                val = hs.userpreference.get("test_user_preference", "com.hammerspoon.hammerspoon")
+                assertIsEqual(val, false)

stickler-ci Mar 15, 2018

(W113) accessing undefined variable 'assertIsEqual'

extensions/userpreference/test_userpreference.lua Outdated

+                hs.userpreference.set("test_user_preference", "aaa", "com.hammerspoon.hammerspoon")
+                val = hs.userpreference.get("test_user_preference", "com.hammerspoon.hammerspoon")
+                assertIsEqual(val, "aaa")

stickler-ci Mar 15, 2018

(W113) accessing undefined variable 'assertIsEqual'

extensions/userpreference/test_userpreference.lua Outdated

+                hs.userpreference.set("test_user_preference", "aaa", "com.hammerspoon.hammerspoon")
+                val = hs.userpreference.get("test_user_preference", "com.hammerspoon.hammerspoon")
+                assertIsEqual(val, "aaa")

stickler-ci Mar 15, 2018

(W611) line contains only whitespace

extensions/userpreference/test_userpreference.lua Outdated

+                hs.userpreference.set("test_user_preference", nil, "com.hammerspoon.hammerspoon")
+                val = hs.userpreference.get("test_user_preference", "com.hammerspoon.hammerspoon")
+                assertIsEqual(val, nil)

stickler-ci Mar 15, 2018

(W113) accessing undefined variable 'assertIsEqual'

extensions/userpreference/test_userpreference.lua Outdated


		hs.userpreference.sync("com.hammerspoon.hammerspoon")

		return success()

stickler-ci Mar 15, 2018

(W113) accessing undefined variable 'success'

Contributor

latenitefilms commented Mar 15, 2018

Amazing work @waynezhang!

My only question is, how does hs.userpreference fit in with @cmsj's hs.plist and @asmagill's WIP hs.preferences?

See issues:

hs.preferences - Property List Editor with NSKeyedArchiver support #1498 - hs.preferences - Property List Editor with NSKeyedArchiver support
CFPreferences #1441 - CFPreferences
Extension for Reading/Writing External Property List Files #1432 - Extension for Reading/Writing External Property List Files

Thoughts @asmagill & @cmsj ?

Member

cmsj commented Mar 15, 2018

(will report some thoughts later, just wanted to quickly drop in to say ignore the sticker CI comments, it doesn't know what it's talking about)

Contributor

latenitefilms commented Mar 15, 2018

@cmsj - I've just made a tweak in #1707 which I think will solve the @stickler-ci errors.

cmsj requested changes

View reviewed changes

Member

cmsj left a comment

This is great stuff, but I think I'd like to change the names - notdisturbmode doesn't match up with the English name for the macOS feature, so maybe it should be hs.donotdisturb?

Also I think hs.userpreference would be better as hs.userpreferences

extensions/userpreference/internal.m Outdated

+                                                                 kCFPreferencesCurrentUser,
+                                                                 kCFPreferencesCurrentHost);
+                  if (ref != nil) {
+                      [skin pushNSObject:(__bridge NSObject *)ref];

Member

cmsj Apr 3, 2018

Small thing, but we tend to use __bridge_transfer rather than __bridge and CFAutorelease().

Contributor Author

waynezhang Jun 20, 2020 •

edited

Loading

Fixed at c043e28

dbalatero commented Aug 22, 2018

@waynezhang Would love to see this merged so I can control DND from the keyboard. Anything I can do to help?

Contributor Author

waynezhang commented Aug 27, 2018

@dbalatero Sorry for late reply. I'm gonna fix this recently when I have time. The tasks left will be:

Rename some variable according to @cmsj's comment
To see if user preference related stuff can be replaced by the PR mentioned by @latenitefilms
I'd be very appreciated if you can lend me some help :)

megalithic commented Oct 3, 2018

@waynezhang any updates/thoughts around resolving these items so @cmsj can merge?

Contributor

latenitefilms commented Oct 3, 2018

I'd love to get @asmagill's thoughts in regards to hs.userpreferences, and how that fits in with the other Preferences/Settings extensions?

kopinions commented Aug 16, 2019

when will this merged?

Contributor

latenitefilms commented Aug 16, 2019

@sjkyspa - The big question here is how to deal with the preferences handling.

What do you think @cmsj & @asmagill ?

Related:

#1498 - hs.preferences - Property List Editor with NSKeyedArchiver support
#1441 - CFPreferences

latenitefilms mentioned this pull request

Wishlist for 2020 #2262

Closed

8 tasks

Contributor

latenitefilms commented Apr 9, 2020

@cmsj & @asmagill - In the interest of merging in the code to solve the original issue in this pull request, I wonder if it's worth just removing hs.userpreference for now, and hardcoding in the preferences stuff directly in hs.donotdisturb so this can be merged, and we can work out what to do with plists in another issue/pull request?

latenitefilms mentioned this pull request

Add NSTableView support to hs._asm.guitk asmagill/hs._asm.guitk#1

Closed

Member

asmagill commented Apr 29, 2020

Sorry I didn't look at this earlier... @latenitefilms since you are the only one I know has used hs._asm.cfpreferences much beyond my initial tests, what are your thoughts on it? What does it need/lack before being submitted for inclusion?

It looks like userpreferences here is a subset, so we could create a wrapper (or even rename mine) if the name seems to make more sense... and since I do note in cfpreferences's limitations that it can't access the "AnyUser" key for writing, renaming mine might actually be worthwhile... the label "cfpreferences" is just a nod to the underlying foundation library being used and wouldn't make sense to someone not somewhat familiar with macOS programming...

Contributor

latenitefilms commented Apr 29, 2020

Currently I'm using a mixture of hs._asm.cfpreferences, hs.plist and our own Lua-based cp.plist (which internally uses plutil and openssl base64) to achieve everything we need. I'll need to go back through our code to work out the pro's and con's of each extension.

From memory, the reason we're using cp.plist in a lot of cases is that we're also using cp.plist.archiver, which supports 'defrosting' a table which is made up from an NSKeyArchiver record. We can't use hs.pasteboard.readArchiverDataForUTI() because we're dealing with classes that Hammerspoon doesn't support.

There were also cases where hs._asm.cfpreferences was giving different results than cp.plist. I can't remember the specifics off the top of my head.

Ideally, I'd love to drop cp.plist and use faster Objective-C implementations.

I think renaming hs._asm.cfpreferences to hs.userpreferences makes sense?

Note to self - these plugins use cp.plist:

plugins.finalcutpro.notifications.manager
plugins.finalcutpro.pasteboard.manager
plugins.finalcutpro.timeline.commandsetactions
cp.apple.finalcutpro.export.destinations
cp.apple.finalcutpro.plugins
cp.disk

These plugins use cp.plist.archiver:

cp.app.menu
cp.apple.finalcutpro.export.destinations
cp.apple.finalcutpro.plugins
plugins.finalcutpro.pasteboard.manager

Also, note to self, that cp.apple.finalcutpro.export.destinations says:

----------------------------------------------------------------------------------
-- TODO: This code currently doesn't work with hs.plist, which is why we're still
--       using cp.plist. Will re-investigate once we have hs.plist.readString()
----------------------------------------------------------------------------------

Will do some experimenting over the coming days to work out what use-cases hs._asm.cfpreferences is currently failing for us.

Contributor

latenitefilms commented Jun 3, 2020

@asmagill - Re-looking at this issue, the hs.userpreference extension added in this pull request can be easily replaced with hs._asm.cfpreferences.

For example:

> cfpreferences = require("hs._asm.cfpreferences")


> cfpreferences.getValue("doNotDisturb", "com.apple.notificationcenterui")
false

> cfpreferences.getValue("doNotDisturb", "com.apple.notificationcenterui")
true

Given that, I'd suggest we try and merge hs._asm.cfpreferences into Hammerspoon at some point when you get time (obviously there's a fair amount of work to do, as hs._asm.cfpreferences is currently undocumented, etc. - I'm happy to help where I can!), then once that's done this pull request just requires a few minor tweaks before it can be merged in. This could either be done by @waynezhang, or I'm happy to help make the necessary changes, once hs._asm.cfpreferences is merged in.

As discussed above, I think renaming hs._asm.cfpreferences to hs.userpreferences also makes sense.

Contributor Author

waynezhang commented Jun 8, 2020

Sorry for leaving this issue untouched for so long a time.
I'll make some fix soon.

@latenitefilms Thanks for the advice. I'm happy to do the migration to _asm.cfpreferences after it's merged to Hammerspoon.

waynezhang added 2 commits

June 20, 2020 22:53


          Add user preference extension

50b0824


          Add extension to control Not Disturb Mode

92cf852

waynezhang force-pushed the master branch from 7d3a280 to 919f964 Compare

June 20, 2020 14:47

stickler-ci reviewed

View reviewed changes

extensions/donotdisturb/test_donotdisturb.lua

		@@ -0,0 +1,17 @@
		hs.donotdisturb = require("hs.donotdisturb")

stickler-ci Jun 20, 2020

(W122) setting read-only field 'donotdisturb' of global 'hs'

extensions/userpreferences/test_userpreferences.lua

		@@ -0,0 +1,25 @@
		hs.userpreferences = require("hs.userpreferences")

stickler-ci Jun 20, 2020

(W122) setting read-only field 'userpreferences' of global 'hs'

extensions/userpreferences/test_userpreferences.lua

+              hs.userpreferences = require("hs.userpreferences")
+              function testUserPreferences()
+                local val = 0

stickler-ci Jun 20, 2020

(W311) value assigned to variable 'val' is overwritten on line 7 before use

extensions/userpreferences/test_userpreferences.lua

+                hs.userpreferences.set("test_user_preferences", "aaa", "com.hammerspoon.hammerspoon")
+                val = hs.userpreferences.get("test_user_preferences", "com.hammerspoon.hammerspoon")
+                assertIsEqual(val, "aaa")

stickler-ci Jun 20, 2020

(W611) line contains only whitespace

Contributor Author

waynezhang commented Jun 20, 2020

I've renamed it to hs.donotdisturb (and hs.userpreference to hs.userpreferences). PTAL.

waynezhang added 2 commits

June 21, 2020 00:13


          Migrate to __bridge_transfer

c043e28


          Rename hs.notdisturbmode to hs.donotdisturb

6537a51

Rename hs.userpreference to hs.userpreferences

waynezhang force-pushed the master branch from 919f964 to 6537a51 Compare

June 20, 2020 15:14

evantravers commented Jun 24, 2020

Nothing to add here but excited to see this 👍

Member

asmagill commented Sep 9, 2020

I want to leave this for 0.9.80 -- I plan to work on the merging of cfpreferences, preferences, settings, etc. after getting 0.9.79 out the door and this would be a perfect fit at that time.

asmagill mentioned this pull request

Version 0.9.81 #2518

Closed

kassi commented Oct 26, 2021

I'm very interested in this feature. Do you have a rough timeline?
Anything someone could help with?

Contributor

latenitefilms commented Oct 27, 2021

@cmsj & @asmagill - I've said this before, but just to suggest again... in the interest of merging in the code to solve the original issue in this pull request, I wonder if it's worth just removing hs.userpreference for now, and hardcoding in the preferences stuff directly in hs.donotdisturb so this can be merged, and we can work out what to do with plists in another issue/pull request?

dbalatero commented Oct 27, 2021 •

edited

Loading

I think in Mojave/Catalina, DND was turned on via user preferences:

https://github.com/dbalatero/dotfiles/blob/master/hammerspoon/pairing-mode.lua#L32-L44

However, the only way I was able to enable it on Big Sur is via UI automation + AppleScript:

https://github.com/dbalatero/dotfiles/blob/master/hammerspoon/pairing-mode.lua#L9-L30

Apple seems to have dropped the user preferences way in favor of something more custom and opaque. Just a heads up that maintaining a DND module might be a moving target in the future!

(I wish Apple would just ship a CLI program to toggle DND, honestly)

Nezteb commented Feb 3, 2022

I'd love this feature; for the time being I'm using this method: https://spinscale.de/posts/2020-10-30-using-hammerspoon-do-not-disturb-screen-sharing-zoom.html

evantravers commented Feb 3, 2022

For anyone else thinking about this in the meantime: if you are on Big Sur you can trigger a shortcut using hs.shortcuts.run to enable Focus Modes or DND. You just have to create the corresponding Shortcuts.

https://github.com/evantravers/hammerspoon-config/blob/219c0fa903ca2c0bafbad2a6564f1c4feb7427f6/spaces/deep.lua#L14

For now… this works really well for me, and I'm ok.

waynezhang closed this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet