feat: web client refresh

.gitignore

@@ -19,3 +19,4 @@ macosx/en.lproj/*~.nib
 node_modules/
 po/*.mo
 third-party/miniupnp/miniupnpcstrings.h
+web/public_html/transmission-app.js.map

CMakeLists.txt

@@ -17,6 +17,7 @@ include(TrMacros)
 tr_auto_option(ENABLE_GTK           "Build GTK+ client" AUTO)
 tr_auto_option(ENABLE_QT            "Build Qt client" AUTO)
 tr_auto_option(ENABLE_MAC           "Build Mac client" AUTO)
+        option(ENABLE_WEB           "Build Web client" OFF)
         option(ENABLE_UTILS         "Build utils (create, edit, show)" ON)
         option(ENABLE_CLI           "Build command-line client" OFF)
         option(ENABLE_TESTS         "Build unit tests" ON)
@@ -622,10 +623,7 @@ if(ENABLE_TESTS)
 endif()
 
 function(tr_install_web DST_DIR)
-    install(DIRECTORY ${CMAKE_SOURCE_DIR}/web DESTINATION ${DST_DIR}
-        PATTERN *.am EXCLUDE
-        PATTERN *.in EXCLUDE
-        PATTERN *.scss EXCLUDE)
+    install(DIRECTORY ${CMAKE_SOURCE_DIR}/web/public_html DESTINATION ${DST_DIR})
 endfunction()
 
 add_subdirectory(libtransmission)
@@ -637,7 +635,7 @@ if(ENABLE_GTK AND ENABLE_NLS)
     add_subdirectory(po)
 endif()
 
-foreach(P daemon cli utils gtk qt mac)
+foreach(P cli daemon gtk mac qt utils web)
     string(TOUPPER "${P}" P_ID)
     if(ENABLE_${P_ID})
         if(DEFINED ${P_ID}_PROJECT_DIR)
@@ -664,7 +662,11 @@ set(CPACK_SOURCE_PACKAGE_FILE_NAME "${TR_NAME}-${TR_USER_AGENT_PREFIX}")
 if(NOT TR_STABLE_RELEASE)
     string(APPEND CPACK_SOURCE_PACKAGE_FILE_NAME "-r${TR_VCS_REVISION}")
 endif()
-list(APPEND CPACK_SOURCE_IGNORE_FILES [.]git)
+list(APPEND CPACK_SOURCE_IGNORE_FILES
+    "${CMAKE_BINARY_DIR}"
+    "[.]git"
+    "node_modules"
+)
 set(CPACK_INSTALL_SCRIPTS "${CMAKE_CURRENT_LIST_DIR}/cmake/CPackSourceFixDirLinks.cmake")
 
 ## Code Formatting

code_style.sh

@@ -62,7 +62,10 @@ fi
 cd "${root}/web" || exit 1
 if [ -n "$fix" ]; then
   cd "${root}/web" && yarn --silent install && yarn --silent 'lint:fix'
-elif ! yarn -s install && yarn --silent lint; then
+elif ! yarn -s install; then
+  echo 'JS code could not be checked -- "yarn install" failed'
+  exitcode=1
+elif ! yarn --silent lint; then
   echo 'JS code needs formatting'
   exitcode=1
 fi

dist/msi/CMakeLists.txt

@@ -53,7 +53,7 @@ png2ico(Transmission.ico
     "${ICONS_DIR}/192x192/transmission-qt.png"
     "${ICONS_DIR}/256x256/transmission-qt.png")
 
-set(WEBSRCDIR "${CMAKE_INSTALL_PREFIX}/share/transmission/web")
+set(WEBSRCDIR "${CMAKE_INSTALL_PREFIX}/share/transmission/public_html")
 set(TRQMSRCDIR "${CMAKE_INSTALL_PREFIX}/share/transmission/translations")
 set(QTQMSRCDIR "${TR_QT_DIR}/translations")
 

dist/msi/Transmission.wxs

@@ -45,7 +45,7 @@
       <Merge Id="VCRedist" SourceFile="$(var.MsvcCrtMsmFile)" DiskId="1" Language="0" />
       <Directory Id="$(var.PlatformProgramFilesFolder)" Name="PFiles">
         <Directory Id="INSTALLDIR" Name="Transmission">
-          <Directory Id="WEBINSTALLDIR" Name="web" />
+          <Directory Id="WEBINSTALLDIR" Name="public_html" />
         </Directory>
       </Directory>
       <Directory Id="ProgramMenuFolder" Name="Programs"/>

libtransmission/platform.c

@@ -493,7 +493,7 @@ char const* tr_getWebClientDir(tr_session const* session)
 #ifdef BUILD_MAC_CLIENT /* on Mac, look in the Application Support folder first, then in the app bundle. */
 
             /* Look in the Application Support folder */
-            s = tr_buildPath(tr_sessionGetConfigDir(session), "web", NULL);
+            s = tr_buildPath(tr_sessionGetConfigDir(session), "public_html", NULL);
 
             if (!isWebClientDir(s))
             {
@@ -511,7 +511,7 @@ char const* tr_getWebClientDir(tr_session const* session)
                 CFRelease(appRef);
 
                 /* Fallback to the app bundle */
-                s = tr_buildPath(appString, "Contents", "Resources", "web", NULL);
+                s = tr_buildPath(appString, "Contents", "Resources", "public_html", NULL);
 
                 if (!isWebClientDir(s))
                 {
@@ -628,7 +628,7 @@ char const* tr_getWebClientDir(tr_session const* session)
             /* walk through the candidates & look for a match */
             for (tr_list* l = candidates; l != NULL; l = l->next)
             {
-                char* path = tr_buildPath(l->data, "transmission", "web", NULL);
+                char* path = tr_buildPath(l->data, "transmission", "public_html", NULL);
                 bool const found = isWebClientDir(path);
 
                 if (found)

libtransmission/rpc-server.c

@@ -279,7 +279,8 @@ static char const* mimetype_guess(char const* path)
         { "html", "text/html" },
         { "ico", "image/vnd.microsoft.icon" },
         { "js", "application/javascript" },
-        { "png", "image/png" }
+        { "png", "image/png" },
+        { "svg", "image/svg+xml" }
     };
     char const* dot = strrchr(path, '.');
 
@@ -1264,5 +1265,11 @@ tr_rpc_server* tr_rpcInit(tr_session* session, tr_variant* settings)
         }
     }
 
+    char const* webClientDir = tr_getWebClientDir(s->session);
+    if (!tr_str_is_empty(webClientDir))
+    {
+        tr_logAddNamedInfo(MY_NAME, _("Serving RPC and Web requests from directory '%s'"), webClientDir);
+    }
+
     return s;
 }

web/.eslintrc.js

@@ -0,0 +1,129 @@
+module.exports = {
+  "env": {
+    "browser": true,
+    "commonjs": true,
+    "es6": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:sonarjs/recommended",
+    "plugin:unicorn/recommended"
+  ],
+  "parser": "@babel/eslint-parser",
+  "parserOptions": {
+    "sourceType": "module"
+  },
+  "plugins": [
+    "sonarjs",
+    "unicorn"
+  ],
+  "rules": {
+    "accessor-pairs": "error",
+    "array-callback-return": "error",
+    "arrow-spacing": "error",
+    "block-scoped-var": "error",
+    "class-methods-use-this": "error",
+    "consistent-return": "error",
+    "curly": "error",
+    "default-case": "error",
+    "default-case-last": "error",
+    "default-param-last": "error",
+    "eqeqeq": "error",
+    "grouped-accessor-pairs": "error",
+    "guard-for-in": "error",
+    "init-declarations": "error",
+    "no-array-constructor": "error",
+    "no-caller": "error",
+    "no-confusing-arrow": "error",
+    "no-constructor-return": "error",
+    "no-delete-var": "error",
+    "no-dupe-class-members": "error",
+    "no-duplicate-imports": "error",
+    "no-else-return": "error",
+    "no-empty-function": "error",
+    "no-eq-null": "error",
+    "no-eval": "error",
+    "no-extend-native": "error",
+    "no-extra-bind": "error",
+    "no-extra-label": "error",
+    "no-floating-decimal": "error",
+    "no-implicit-coercion": "error",
+    "no-implicit-globals": "error",
+    "no-implied-eval": "error",
+    "no-invalid-this": "error",
+    "no-iterator": "error",
+    "no-label-var": "error",
+    "no-labels": "error",
+    "no-lone-blocks": "error",
+    "no-loop-func": "error",
+    "no-loss-of-precision": "error",
+    "no-multi-str": "error",
+    "no-nested-ternary": "error",
+    "no-new": "error",
+    "no-new-func": "error",
+    "no-new-wrappers": "error",
+    "no-octal": "error",
+    "no-octal-escape": "error",
+    "no-promise-executor-return": "error",
+    "no-proto": "error",
+    "no-redeclare": "error",
+    "no-restricted-exports": "error",
+    "no-restricted-globals": "error",
+    "no-restricted-imports": "error",
+    "no-restricted-properties": "error",
+    "no-return-assign": "error",
+    "no-script-url": "error",
+    "no-self-compare": "error",
+    "no-sequences": "error",
+    "no-shadow": "error",
+    "no-template-curly-in-string": "error",
+    "no-this-before-super": "error",
+    "no-throw-literal": "error",
+    "no-undef-init": "error",
+    "no-undefined": "error",
+    "no-unmodified-loop-condition": "error",
+    "no-unreachable-loop": "error",
+    "no-unused-expressions": "error",
+    "no-unused-labels": "error",
+    "no-unused-vars": "error",
+    "no-use-before-define": "error",
+    "no-useless-backreference": "error",
+    "no-useless-call": "error",
+    "no-useless-catch": "error",
+    "no-useless-computed-key": "error",
+    "no-useless-concat": "error",
+    "no-useless-constructor": "error",
+    "no-useless-escape": "error",
+    "no-useless-rename": "error",
+    "no-useless-return": "error",
+    "no-var": "error",
+    "no-void": "error",
+    "no-with": "error",
+    "object-shorthand": "error",
+    "prefer-arrow-callback": "error",
+    "prefer-const": "error",
+    "prefer-destructuring": "error",
+    "prefer-exponentiation-operator": "error",
+    "prefer-numeric-literals": "error",
+    "prefer-object-spread": "error",
+    "prefer-promise-reject-errors": "error",
+    "prefer-regex-literals": "error",
+    "prefer-rest-params": "error",
+    "prefer-spread": "error",
+    "prefer-template": "error",
+    "radix": "error",
+    "require-atomic-updates": "error",
+    "require-await": "error",
+    "semi": "error",
+    "sonarjs/cognitive-complexity": "off",
+    "sonarjs/no-duplicate-string": "off",
+    "sort-keys": "error",
+    "strict": "error",
+    'unicorn/consistent-function-scoping': 'off',
+    "unicorn/no-fn-reference-in-iterator": "off",
+    "unicorn/no-null": "off",
+    "unicorn/no-reduce": "off",
+    "unicorn/no-unused-properties": "off",
+    "unicorn/prevent-abbreviations": "off",
+  }
+};

web/CMakeLists.txt

@@ -0,0 +1,17 @@
+project(trweb)
+
+file(GLOB trweb_srcs "src/*.js" "style/*.scss")
+file(GLOB trweb_imgs "style/images/*.png")
+
+add_custom_target(
+  trweb ALL
+  COMMAND ${CMAKE_COMMAND} -E copy "${CMAKE_CURRENT_SOURCE_DIR}/package.json" "${CMAKE_CURRENT_BINARY_DIR}/package.json"
+  COMMAND ${CMAKE_COMMAND} -E copy "${CMAKE_CURRENT_SOURCE_DIR}/yarn.lock" "${CMAKE_CURRENT_BINARY_DIR}/yarn.lock"
+  COMMAND yarn install
+  COMMAND yarn webpack --config "${CMAKE_CURRENT_SOURCE_DIR}/webpack.config.js" --context "${CMAKE_CURRENT_SOURCE_DIR}"
+  BYPRODUCTS
+    public_html/transmission-app.js
+    public_html/transmission-app.js.LICENSE.txt
+  DEPENDS ${trweb_imgs}
+  SOURCES ${trweb_srcs}
+)