conf/afm-unit.conf

   1 ;---------------------------------------------------------------------------------
   2 ; File:
   3 ;
   4 ;    afm-unit.conf
   5 ;
   6 ; Role:
   7 ;
   8 ;    Configure how installation of widget produces unit files for systemd
   9 ;
  10 ; Processing and format:
  11 ;
  12 ;    1. File load
  13 ;
  14 ;           Lines beginning with ; are firstly removed
  15 ;
  16 ;    2. File instanciation
  17 ;
  18 ;           Mustache (extended) substitutions are applied using JSON
  19 ;           data deduced from config.xml file of the widget.
  20 ;
  21 ;    3. Extraction of units
  22 ;
  23 ;           Extract produced units, pack it (remove empty lines and directives)
  24 ;
  25 ; Directives:
  26 ;
  27 ;    Any directive occupy one whole line starting with %
  28 ;
  29 ;     - %nl
  30 ;
  31 ;             produce an empty line at the end
  32 ;
  33 ;     - %begin systemd-unit
  34 ;     - %end systemd-unit
  35 ;
  36 ;             delimit the produced unit
  37 ;
  38 ;     - %systemd-unit user
  39 ;     - %systemd-unit system
  40 ;
  41 ;             tells the kind of unit (user/system)
  42 ;
  43 ;     - %systemd-unit service NAME
  44 ;     - %systemd-unit socket NAME
  45 ;
  46 ;             gives the name and type of the unit
  47 ;
  48 ;     - %systemd-unit wanted-by NAME
  49 ;
  50 ;             tells to install a link to unit in the wants of NAME
  51 ;
  52 ; Setting variables:
  53 ;
  54 ;    AFM uses the feature of systemd that completely ignores options prefixed
  55 ;    with X-
  56 ;
  57 ;    Consequently, options starting with X-AFM- are recorded as public data
  58 ;    about the application and options starting starting with X-AFM-- are
  59 ;    recorded as private data.
  60 ;
  61 ;    Examples:
  62 ;
  63 ;        X-AFM-description={{description}}
  64 ;
  65 ;              Records the descritpion of the unit in the field "description"
  66 ;              of both the public and private object describing the unit.
  67 ;
  68 ;        X-AFM--wgtdir={{:#metadata.install-dir}}
  69 ;
  70 ;              Records the installation directory path in the field "wgtdir"
  71 ;              of the private object only.
  72 ;
  73 ;---------------------------------------------------------------------------------
  74 {{#targets}}
  75
  76 ;---------------------------------------------------------------------------------
  77 ;----        P R O V I D E D   U N I T S                                      ----
  78 ;---------------------------------------------------------------------------------
  79 %begin systemd-unit
  80
  81 # auto generated by wgtpkg-unit for {{id}} version {{version}} target {{:#target}} of {{idaver}}
  82 %nl
  83
  84 [Unit]
  85 Description={{description}}
  86 X-AFM-description={{description}}
  87 X-AFM-name={{name.content}}
  88 X-AFM-shortname={{name.short}}
  89 X-AFM-id={{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}
  90 X-AFM-version={{version}}
  91 X-AFM-author={{author.content}}
  92 X-AFM-author-email={{author.email}}
  93 X-AFM-width={{width}}
  94 X-AFM-height={{height}}
  95 X-AFM--ID={{id}}
  96 X-AFM--target-name={{:#target}}
  97 X-AFM--content={{content.src}}
  98 X-AFM--type={{content.type}}
  99 X-AFM--wgtdir={{:#metadata.install-dir}}
 100 X-AFM--workdir={{&#metadata.app-data-dir}}/{{id}}
 101 %nl
 102
 103 # Adds check to smack
 104 ConditionSecurity=smack
 105 %nl
 106
 107 # Automatic bound to required api
 108 {{#required-api}}
 109 BindsTo=afm-api-{{name}}
 110 After=afm-api-{{name}}
 111 {{/required-api}}
 112 %nl
 113
 114 [Service]
 115 SmackProcessLabel=User::App::{{id}}
 116 SuccessExitStatus=0 SIGKILL
 117
 118 {{#required-permission}}
 119   {{#urn:AGL:permission::platform:no-oom}}      OOMScoreAdjust=-500             {{/urn:AGL:permission::platform:no-oom}}
 120   {{#urn:AGL:permission::partner:real-time}}    IOSchedulingClass=realtime      {{/urn:AGL:permission::partner:real-time}}
 121   {{^urn:AGL:permission::partner:real-time}}    RestrictRealtime=on             {{/urn:AGL:permission::partner:real-time}}
 122   {{#urn:AGL:permission::public:display}}       SupplementaryGroups=display     {{/urn:AGL:permission::public:display}}
 123   {{^urn:AGL:permission::public:syscall:clock}} SystemCallFilter=~@clock        {{/urn:AGL:permission::public:syscall:clock}}
 124 {{/required-permission}}
 125 %nl
 126
 127 WorkingDirectory=-{{&#metadata.app-data-dir}}/{{id}}
 128 ExecStartPre=/bin/mkdir -p {{&#metadata.app-data-dir}}/{{id}}
 129 Environment=AFM_APP_INSTALL_DIR={{:#metadata.install-dir}}
 130
 131 %systemd-unit user
 132 {{#required-permission.urn:AGL:permission::public:hidden}}\
 133 %systemd-unit service afm-service-{{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}
 134 {{/required-permission.urn:AGL:permission::public:hidden}}\
 135 {{^required-permission.urn:AGL:permission::public:hidden}}\
 136 %systemd-unit service afm-appli-{{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}
 137 {{/required-permission.urn:AGL:permission::public:hidden}}\
 138
 139 ;---------------------------------------------------------------------------------
 140 ;----                 text/html                                               ----
 141 ;---------------------------------------------------------------------------------
 142 {{#content.type=text/html}}
 143
 144 X-AFM--http-port={{:#metadata.http-port}}
 145 ExecStart=/usr/bin/afb-daemon \
 146         --port={{:#metadata.http-port}} \
 147         --random-token \
 148         --rootdir={{:#metadata.install-dir}} \
 149         --workdir={{&#metadata.app-data-dir}}/{{id}} \
 150         {{#required-permission.urn:AGL:permission::public:no-htdocs}}\
 151                 --roothttp=. \
 152         {{/required-permission.urn:AGL:permission::public:no-htdocs}}\
 153         {{^required-permission.urn:AGL:permission::public:no-htdocs}}\
 154                 --roothttp=htdocs \
 155         {{/required-permission.urn:AGL:permission::public:no-htdocs}}\
 156         {{#required-permission.urn:AGL:permission::public:applications:read}}\
 157                 --alias=/icons:{{:#metadata.icons-dir}} \
 158         {{/required-permission.urn:AGL:permission::public:applications:read}}\
 159         {{#required-api}}\
 160                 {{#value=auto}}\
 161                         --ws-client=unix:%t/apis/ws/{{name}} \
 162                 {{/value=auto}}\
 163                 {{#value=ws}}\
 164                         --ws-client=unix:%t/apis/ws/{{name}} \
 165                 {{/value=ws}}\
 166                 {{#value=dbus}}\
 167                         --dbus-client={{name}} \
 168                 {{/value=dbus}}\
 169                 {{#value=link}}\
 170                         --binding=%t/apis/lib/{{name}} \
 171                 {{/value=link}}\
 172                 {{#value=cloud}}\
 173                         --cloud-client={{name}} \
 174                 {{/value=cloud}}\
 175                 {{#value=local}}\
 176                         --binding={{:#metadata.install-dir}}/{{name}} \
 177                 {{/value=local}}\
 178         {{/required-api}}\
 179         {{#provided-api}}\
 180                 {{#value=auto}}\
 181                         {{^required-permission.urn:AGL:permission::partner:service:no-ws}}\
 182                                 --ws-server=sd:{{name}} \
 183                         {{/required-permission.urn:AGL:permission::partner:service:no-ws}}\
 184                         {{^required-permission.urn:AGL:permission::partner:service:no-dbus}}\
 185                                 --dbus-server={{name}} \
 186                         {{/required-permission.urn:AGL:permission::partner:service:no-dbus}}\
 187                 {{/value=auto}}\
 188                 {{#value=ws}}\
 189                         --ws-server=sd:{{name}} \
 190                 {{/value=ws}}\
 191                 {{#value=dbus}}\
 192                         --dbus-server={{name}} \
 193                 {{/value=dbus}}\
 194         {{/provided-api}}\
 195         --exec /usr/bin/web-runtime http://localhost:@p/{{content.src}}?token=@t
 196
 197 {{/content.type=text/html}}
 198
 199 ;---------------------------------------------------------------------------------
 200 ;----                 application/x-executable                                ----
 201 ;---------------------------------------------------------------------------------
 202 {{#content.type=application/x-executable}}
 203
 204 Environment=LD_LIBRARY_PATH=$ORIGIN/$LIB
 205
 206 ExecStart={{:#metadata.install-dir}}/{{content.src}}
 207
 208 {{/content.type=application/x-executable}}
 209
 210 ;---------------------------------------------------------------------------------
 211 ;----                 application/vnd.agl.service                             ----
 212 ;---------------------------------------------------------------------------------
 213 {{#content.type=application/vnd.agl.service}}
 214
 215 ExecStart=/usr/bin/afb-daemon \
 216         --rootdir={{:#metadata.install-dir}} \
 217         --workdir={{&#metadata.install-dir}}/{{id}} \
 218         {{#required-api}}\
 219                 {{#value=auto}}\
 220                         --ws-client=unix:%t/apis/ws/{{name}} \
 221                 {{/value=auto}}\
 222                 {{#value=ws}}\
 223                         --ws-client=unix:%t/apis/ws/{{name}} \
 224                 {{/value=ws}}\
 225                 {{#value=dbus}}\
 226                         --dbus-client={{name}} \
 227                 {{/value=dbus}}\
 228                 {{#value=link}}\
 229                         --binding=%t/apis/lib/{{name}} \
 230                 {{/value=link}}\
 231                 {{#value=cloud}}\
 232                         --cloud-client={{name}} \
 233                 {{/value=cloud}}\
 234                 {{#value=local}}\
 235                         --binding={{:#metadata.install-dir}}/{{name}} \
 236                 {{/value=local}}\
 237         {{/required-api}}\
 238         {{#provided-api}}\
 239                 {{#value=auto}}\
 240                         {{^required-permission.urn:AGL:permission::partner:service:no-ws}}\
 241                                 --ws-server=sd:{{name}} \
 242                         {{/required-permission.urn:AGL:permission::partner:service:no-ws}}\
 243                         {{^required-permission.urn:AGL:permission::partner:service:no-dbus}}\
 244                                 --dbus-server={{name}} \
 245                         {{/required-permission.urn:AGL:permission::partner:service:no-dbus}}\
 246                 {{/value=auto}}\
 247                 {{#value=ws}}\
 248                         --ws-server=sd:{{name}} \
 249                 {{/value=ws}}\
 250                 {{#value=dbus}}\
 251                         --dbus-server={{name}} \
 252                 {{/value=dbus}}\
 253         {{/provided-api}}\
 254         --no-httpd
 255
 256
 257 {{/content.type=application/vnd.agl.service}}
 258
 259
 260 ;---------------------------------------------------------------------------------
 261 ; auto start
 262 ;---------------------------------------------------------------------------------
 263 {{#required-permission.urn:AGL:permission::system:run-by-default}}
 264 {{^provided-api}}
 265 %nl
 266 [Install]
 267 WantedBy=default.target
 268 %systemd-unit wanted-by default.target
 269 {{/provided-api}}
 270 {{/required-permission.urn:AGL:permission::system:run-by-default}}
 271
 272 %end systemd-unit
 273
 274
 275 ;---------------------------------------------------------------------------------
 276 ;----        P R O V I D E D   A P I S                                        ----
 277 ;---------------------------------------------------------------------------------
 278
 279 {{#provided-api}}
 280 {{#value=ws}}
 281
 282 %begin systemd-unit
 283
 284 # auto generated by wgtpkg-unit for {{id}} version {{version}} target {{:#target}} of {{idaver}}
 285 #
 286 %systemd-unit user
 287 %systemd-unit socket afm-socket-{{name}}
 288
 289 [Socket]
 290 SmackLabel=*
 291 ListenStream=%t/bindings/{{name}}
 292 FileDescriptorName={{name}}
 293
 294 {{#required-permission.urn:AGL:permission::public:hidden}}\
 295 Service=afm-service-{{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}
 296 {{/required-permission.urn:AGL:permission::public:hidden}}\
 297 {{^required-permission.urn:AGL:permission::public:hidden}}\
 298 Service=afm-appli-{{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}
 299 {{/required-permission.urn:AGL:permission::public:hidden}}\
 300
 301 ;---------------------------------------------------------------------------------
 302 {{#required-permission.urn:AGL:permission::system:run-by-default}}
 303 %nl
 304 [Install]
 305 WantedBy=default.target
 306 %systemd-unit wanted-by default.target
 307 {{/required-permission.urn:AGL:permission::system:run-by-default}}
 308 ;---------------------------------------------------------------------------------
 309
 310 %end systemd-unit
 311
 312 {{/value=ws}}
 313 {{#value=auto}}
 314
 315 %begin systemd-unit
 316
 317 # auto generated by wgtpkg-unit for {{id}} version {{version}} target {{:#target}} of {{idaver}}
 318 #
 319 %systemd-unit user
 320 %systemd-unit socket afm-socket-{{name}}
 321
 322 [Socket]
 323 SmackLabel=*
 324 ListenStream=%t/bindings/{{name}}
 325 FileDescriptorName={{name}}
 326
 327 {{#required-permission.urn:AGL:permission::public:hidden}}\
 328 Service=afm-service-{{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}
 329 {{/required-permission.urn:AGL:permission::public:hidden}}\
 330 {{^required-permission.urn:AGL:permission::public:hidden}}\
 331 Service=afm-appli-{{idaver}}{{^#target=main}}@{{:#target}}{{/#target=main}}
 332 {{/required-permission.urn:AGL:permission::public:hidden}}\
 333
 334 ;---------------------------------------------------------------------------------
 335 {{#required-permission.urn:AGL:permission::system:run-by-default}}
 336 %nl
 337 [Install]
 338 WantedBy=default.target
 339 %systemd-unit wanted-by default.target
 340 {{/required-permission.urn:AGL:permission::system:run-by-default}}
 341 ;---------------------------------------------------------------------------------
 342
 343 %end systemd-unit
 344
 345 {{/value=auto}}
 346 {{/provided-api}}
 347
 348 {{/targets}}
 349