INFO and config alignment spksrc.service.mk

[BKSteve]

Create config file with same id as INFO file.

Motivation: DSM7 notification not working as INFO file of package and config file are not aligned in naming convention.

Linked issues: https://github.com/SickChill/SickChill/issues/7694#issuecomment-986926967

Thus synodsmnotify even if strings were configured correctly would not resolve their i18n text strings.

@th0ma7 I don't know the knock on effects of this modification to other parts of the build. Also the other choice may be to modify the spksrc.spk.mk file lines 204 to 206 to change the INFO file instead.

[hgy59]

The following code in spksrc.spk.mk must be updated

ifneq ($(strip $(DSM_APP_NAME)),)
	@echo dsmappname=\"$(DSM_APP_NAME)\" >> $@
	@echo dsmapppage=\"$(DSM_APP_NAME)\" >> $@
	@echo dsmapplaunchname=\"$(DSM_APP_NAME)\" >> $@
else
	@echo dsmappname=\"com.synocommunity.$(SPK_NAME)\" >> $@
	@echo dsmapppage=\"com.synocommunity.$(SPK_NAME)\" >> $@
	@echo dsmapplaunchname=\"com.synocommunity.$(SPK_NAME)\" >> $@
endif

1. The prefix must be com.synocommunity.packages.
2. dsmapppage must not be the same as dsmappname
3. dsmapplaunchname is optional and must only be defined if different than dsmappname
4. dsmapppage and dsmapplaunchname are valid for DSM 7 only

So it should look something like this:

ifneq ($(strip $(DSM_APP_NAME)),)
	@echo dsmappname=\"$(DSM_APP_NAME)\" >> $@
else
	@echo dsmappname=\"com.synocommunity.packages.$(SPK_NAME)\" >> $@
endif
ifeq ($(call version_ge, ${TCVERSION}, 7.0),1)
ifneq ($(strip $(DSM_APP_PAGE)),)
	@echo dsmapppage=\"$(DSM_APP_PAGE)\" >> $@
endif
ifneq ($(strip $(DSM_APP_LAUNCH_NAME)),)
	@echo dsmapplaunchname=\"$(DSM_APP_LAUNCH_NAME)\" >> $@
endif
endif

[hgy59]

ifneq ($(strip $(DSM_APP_NAME)),)
@echo dsmappname="$(DSM_APP_NAME)" >> $@
else
@echo dsmappname="com.synocommunity.packages.$(SPK_NAME)" >> $@
endif
ifeq ($(call version_ge, ${TCVERSION}, 7.0),1)
ifneq ($(strip $(DSM_APP_PAGE)),)
@echo dsmapppage="$(DSM_APP_PAGE)" >> $@
endif
ifneq ($(strip $(DSM_APP_LAUNCH_NAME)),)
@echo dsmapplaunchname="$(DSM_APP_LAUNCH_NAME)" >> $@
endif
endif

BTW this brings back the DSM desktop icons for synocommunity apps in DSM 6 and DSM 7.

@BKSteve can you please explain what the synodsmnotify means and how we can test it.

[hgy59]

this is just an update of the comment and has to be validated for correct implementation.

[hgy59]

@BKSteve can you please explain what the synodsmnotify means and how we can test it.

Just found it in the Dev Guide (page 59):

Show Message as Desktop Notification

It is possible to use /usr/syno/bin/synodsmnotify executable to send desktop notifications to users. The notification title / message
must be an I18N string.

/usr/syno/bin/synodsmnotify -c [app_id] [user_or_group] [i18n_string_for_title] [i18n_string_for_msg]

/usr/syno/bin/synodsmnotify -c com.company.App1 admin MyPackage:app_tree:index_title MyPackage:app_tree:node_1

/usr/syno/bin/synodsmnotify -c com.company.App1 @administrators MyPackage:app_tree:index_title MyPackage:app_tree:node_1

Notification title and message here should be in the format of [package_id]:[i18n_section]:[i18n_key] where package_id is the package value in package INFO file. I18N string example can be found in I18N page. Remember to specify desktop notification strings to preloadTexts field in application config.

[BKSteve]

BTW this brings back the DSM desktop icons for synocommunity apps in DSM 6 and DSM 7.

Yes, when the two files config and INFO align they will work together.

the other choice may be to modify the spksrc.spk.mk file lines 204 to 206 to change the INFO file instead.

So from the edits that clears up that question / comment.

I have another question, is it necessary to do
ifeq ($(call version_ge, ${TCVERSION}, 7.0),1)
as I thought both DSM6 and DSM7 would still need the dsmapppage and dsmapplaunchname but I can't see where these variables are set for DSM6.

Does this also mean that DSM_APP_PAGE and DSM_APP_LAUNCH_NAME need to be defined elsewhere? These variables aren't in any other location that I can find.

Add1:
On the text from page 59 of the manual.
You don't need the -c com.company.App1 in the string
/usr/syno/bin/synodsmnotify -c com.company.App1 @administrators MyPackage:app_tree:index_title MyPackage:app_tree:node_1
so to trigger notification this works
/usr/syno/bin/synodsmnotify @administrators MyPackage:app_tree:index_title MyPackage:app_tree:node_1

Add2:
You may have seen me asking how to get some strings into the config file on Discord but for SickChill this isn't important as it's only used (presently) for when running notifications and not starting up or shutdown notifications.
My config manually edited with "preloadTexts": [ "appsc:apptitle", "appsc:action" ] done for testion

{
  ".url": {
    "com.synocommunity.packages.sickchill": {
      "type": "url",
      "title": "SickChill",
      "desc": "Automatic Video Library Manager for TV Shows. It watches for new episodes of your favorite shows, and when they are posted it does its magic.",
      "icon": "images/sickchill-{0}.png",
      "protocol": "http",
      "port": "8081",
      "url": "/",
      "allUsers": true,
      "grantPrivilege": "all",
      "advanceGrantPrivilege": true,
      "texts": "texts",
      "preloadTexts": [
        "appsc:apptitle",
        "appsc:action"
      ]
    }
  }
}

The "texts": "texts", may or may not be required as it was added whilst I was working with Synology on getting this to work.
Then /volume1/@appstore/sickchill/app/texts/enu/strings

[appsc]
action = "Action"
apptitle = "SickChill"

in line with the above the activation string for my testing was
/usr/syno/bin/synodsmnotify @administrators sickchill:appsc:apptitle sickchill:appsc:action
Which eventually worked once INFO and config were aligned, initially to com.synocommunity.sickchill but sure it'll work if all are com.synocommunity.packages.sickchill

[hgy59]

I have another question, is it necessary to do ifeq ($(call version_ge, ${TCVERSION}, 7.0),1) as I thought both DSM6 and DSM7 would still need the dsmapppage and dsmapplaunchname but I can't see where these variables are set for DSM6.

Does this also mean that DSM_APP_PAGE and DSM_APP_LAUNCH_NAME need to be defined elsewhere? These variables aren't in any other location that I can find.

Just from the dev guide (dsmapppage and dsmapplaunchname are new for DSM 7):

Field Name: dsmappname

• Description: The value of each individual application will be equal to the unique property name in DSM’s config file so as to be
  integrated into Synology DiskStation.

  Note: Please refer Config in Integrate Your package into DSM chapter for more information.

• Value: (Separated with a space)
• Default Value: (Empty)
• Example:

  dsmappname="SYNO.SDS.PhotoStation SYNO.SDS.PersonalPhotoStation"
  

• DSM Requirement: 3.2-1922

Field Name: dsmapppage

• Description: The application page to open when click on package open button (should be used with dsmappname key)
• Value: Page name

  Note: page name corresponds to PageListAppWindow's fn value when calling SYNO.SDS.AppLaunch

• Default Value: (Empty)
• Example:

  dsmappname="SYNO.SDS.AdminCenter.Application"
  dsmapppage="SYNO.SDS.AdminCenter.FileService.Main"
  

• DSM Requirement: 7.0-40332

Field Name: dsmapplaunchname

• Description: The value will be used to launch desktop app, and it has higher priority than dsmappname.
• Value: App name
• Default Value: same as dsmappname
• Example:

  dsmapplaunchname="SYNO.SDS.AdminCenter.Application"
  

• DSM Requirement: 7.0-40796

---

As the values for dsmapppage and dsmapplaunchname are app specific, I introduced related Makefile variables. Those should never be the same as dsmappname.

Tie fields dsmappname, dsmapppage and dsmapplaunchname are optional in the INFO file and are only required for packages that need DSM desktop integration.
Packages that need such values in the INFO file must define DSM_APP_PAGE and/or DSM_APP_LAUNCH_NAME in the spk Makefile.
Plus those values must have matching definitions in the package app config file.

[BKSteve]

Here's my INFO file first 20 lines as installed in /var/packages/sickchill/ in my DSM7 which are the same as the INFO file in spk.
I've just checked my DSM6 and they existed in that INFO file too, all the same.

package="sickchill"
version="20211110-4"
description="Automatic Video Library Manager for TV Shows. It watches for new episodes of your favorite shows, and when they are posted it does its magic."

arch="apollolake avoton braswell broadwell broadwellnk bromolow cedarview denverton dockerx64 geminilake grantley purley kvmx64 v1000 x86 x86_64"
maintainer="miigotu"
maintainer_url=""
distributor=""
distributor_url=""
os_min_ver="7.0-41890" [ OR os_min_ver="6.1-15047"]
helpurl="https://sickchill.github.io/"
displayname="SickChill"
dsmuidir="app"
dsmappname="com.synocommunity.sickchill"
dsmapppage="com.synocommunity.sickchill"
dsmapplaunchname="com.synocommunity.sickchill"
adminport="8081"
changelog="1. SickChill environment fix<br/>2. Move to Python 3.8 without git<br/>3. Added DSM7 Support<br/>4. cryptography resolution for armv7"
install_dep_packages="python38>=3.8.12-6"
checksum="4383ccaaac0d2b013e4ec33f3ed3894c"

[th0ma7]

Interestingly I noticed that tvheadend on DSM7 does not show an icon anymore... neither are other "web" applications. Is this related?

[BKSteve]

As the two files don't line up with each other then it can't match the information in the config file to what INFO is telling it to look for.
So yes most likely the cause.

After I set both files to contain com.synocommunity.packages.sickchill and restarted the icon was back. With only com.synocommunity.sickchill it was not there.

[hgy59]

I've just checked my DSM6 and they existed in that INFO file too, all the same.

Yes, that was what the spksrc framework generated, but the synology dev guide tells, that dsmapppage and dsmapplaunchname are not used in DSM 6.

[hgy59]

Interestingly I noticed that tvheadend on DSM7 does not show an icon anymore... neither are other "web" applications. Is this related?

Yes, that was my finding too, and therefore I jumped into this PR (was originally created to solve the DSM notifications from sickchill).

[BKSteve]

Yes, that was what the spksrc framework generated, but the synology dev guide tells, that dsmapppage and dsmapplaunchname are not used in DSM 6.

But why bother taking it out with if statements if it causes no issue?

I also don't fully understand how to use those 2 new items either

[th0ma7]

My PR #4994 is close to ready for merge but I'm really much interested in having this icon thing fixed. I'll wait for this fix to get in before publishing my tvheadend update. I haven't played much with that portion of the code but let me know if I can be of assistance.

[BKSteve]

I will also leave it to the professionals. I've done my bit, identified and proposed a solution/s. Which will fix the initial issue and by chance another.

Leaving this to you guys in SynoComm now.

[th0ma7]

@hgy59 and @BKSteve tested with tvheadend on DSM7 and its now working great! Good job!