From 780b429fa909e638c8302e46ea84424770cbcd48 Mon Sep 17 00:00:00 2001
From: Hawtim Zhang <hawtimzhang@gmail.com>
Date: Sat, 24 Oct 2020 18:55:10 +0800
Subject: [PATCH] feat: using vuex to make login status reactively (#51)

---
 src/api/track.js                 |  3 +-
 src/components/Player.vue        | 12 ++++----
 src/components/TrackListItem.vue |  8 ++----
 src/router/index.js              | 42 +++++++++++++--------------
 src/store/actions.js             |  5 ++--
 src/store/mutations.js           | 10 +++++++
 src/store/state.js               |  2 ++
 src/utils/auth.js                | 28 ++++++++++++++++++
 src/utils/common.js              |  4 +--
 src/views/album.vue              |  4 +--
 src/views/loginAccount.vue       | 49 ++++++++++++++++++--------------
 src/views/loginUsername.vue      |  6 ++--
 src/views/playlist.vue           |  8 ++----
 13 files changed, 110 insertions(+), 71 deletions(-)

diff --git a/src/api/track.js b/src/api/track.js
index 1fe0be9..1b50eea 100644
--- a/src/api/track.js
+++ b/src/api/track.js
@@ -3,7 +3,8 @@ import request from "@/utils/request";
 import { mapTrackPlayableStatus } from "@/utils/common";
 /**
  * 获取音乐 url
- * 说明 : 使用歌单详情接口后 , 能得到的音乐的 id, 但不能得到的音乐 url, 调用此接口, 传入的音乐 id( 可多个 , 用逗号隔开 ), 可以获取对应的音乐的 url,未登录状态返回试听片段(返回字段包含被截取的正常歌曲的开始时间和结束时间)
+ * 说明 : 使用歌单详情接口后 , 能得到的音乐的 id, 但不能得到的音乐 url, 调用此接口, 传入的音乐 id( 可多个 , 用逗号隔开 ), 可以获取对应的音乐的 url,
+ * !!!未登录状态返回试听片段(返回字段包含被截取的正常歌曲的开始时间和结束时间)
  * @param {string} id - 音乐的 id，例如 id=405998841,33894312
  */
 export function getMP3(id) {
diff --git a/src/components/Player.vue b/src/components/Player.vue
index 12f661e..53c84fe 100644
--- a/src/components/Player.vue
+++ b/src/components/Player.vue
@@ -36,7 +36,8 @@
             </span>
           </div>
         </div>
-        <div class="like-button" v-show="isLoggedIn">
+        <!-- 账号登录才会显示 like 图标 -->
+        <div class="like-button" v-show="accountLogin">
           <button-icon
             @click.native="likeCurrentSong"
             :title="$t('player.like')"
@@ -118,7 +119,7 @@
 <script>
 import { updateMediaSessionMetaData } from "@/utils/mediaSession";
 import { mapState, mapMutations, mapActions } from "vuex";
-import { isLoggedIn } from "@/utils/auth";
+import { isAccountLoggedIn } from "@/utils/auth";
 import { userLikedSongsIDs } from "@/api/user";
 import { likeATrack } from "@/api/track";
 import "@/assets/css/slider.css";
@@ -144,14 +145,14 @@ export default {
     setInterval(() => {
       this.progress = ~~this.howler.seek();
     }, 1000);
-    if (this.isLoggedIn) {
+    if (isAccountLoggedIn()) {
       userLikedSongsIDs(this.settings.user.userId).then((data) => {
         this.updateLikedSongs(data.ids);
       });
     }
   },
   computed: {
-    ...mapState(["player", "howler", "settings", "liked"]),
+    ...mapState(["player", "howler", "settings", "liked", "accountLogin"]),
     currentTrack() {
       return this.player.currentTrack;
     },
@@ -174,9 +175,6 @@ export default {
       let max = ~~(this.currentTrack.dt / 1000);
       return max > 1 ? max - 1 : max;
     },
-    isLoggedIn() {
-      return isLoggedIn();
-    },
   },
   methods: {
     ...mapMutations([
diff --git a/src/components/TrackListItem.vue b/src/components/TrackListItem.vue
index bb574ae..ab44583 100644
--- a/src/components/TrackListItem.vue
+++ b/src/components/TrackListItem.vue
@@ -60,7 +60,7 @@
       <div></div>
     </div>
     <div class="actions" v-if="!isTracklist">
-      <button v-if="isLoggedIn" @click="likeThisSong">
+      <button v-if="accountLogin" @click="likeThisSong">
         <svg-icon
           icon-class="heart"
           :style="{
@@ -78,7 +78,7 @@
 </template>
 
 <script>
-import { isLoggedIn } from "@/utils/auth";
+import { mapState } from "vuex";
 
 import ArtistsInLine from "@/components/ArtistsInLine.vue";
 import ExplicitSymbol from "@/components/ExplicitSymbol.vue";
@@ -93,6 +93,7 @@ export default {
     return { focus: false, trackStyle: {} };
   },
   computed: {
+    ...mapState(["accountLogin"]),
     imgUrl() {
       if (this.track.al !== undefined) return this.track.al.picUrl;
       if (this.track.album !== undefined) return this.track.album.picUrl;
@@ -127,9 +128,6 @@ export default {
       if (this.isPlaying) trackClass.push("playing");
       return trackClass;
     },
-    isLoggedIn() {
-      return isLoggedIn();
-    },
   },
   methods: {
     goToAlbum() {
diff --git a/src/router/index.js b/src/router/index.js
index 3d228b2..3b0ff37 100644
--- a/src/router/index.js
+++ b/src/router/index.js
@@ -3,7 +3,7 @@ import VueRouter from "vue-router";
 import store from "@/store";
 import NProgress from "nprogress";
 import "@/assets/css/nprogress.css";
-import Cookies from "js-cookie";
+import { isLooseLoggedIn } from "@/utils/auth";
 
 NProgress.configure({ showSpinner: false, trickleSpeed: 100 });
 
@@ -12,7 +12,7 @@ const routes = [
   {
     path: "/",
     name: "home",
-    component: () => import("@/views/home"),
+    component: () => import("@/views/home.vue"),
     meta: {
       keepAlive: true,
     },
@@ -20,32 +20,32 @@ const routes = [
   {
     path: "/login",
     name: "login",
-    component: () => import("@/views/login"),
+    component: () => import("@/views/login.vue"),
   },
   {
     path: "/login/username",
     name: "loginUsername",
-    component: () => import("@/views/loginUsername"),
+    component: () => import("@/views/loginUsername.vue"),
   },
   {
     path: "/login/account",
     name: "loginAccount",
-    component: () => import("@/views/loginAccount"),
+    component: () => import("@/views/loginAccount.vue"),
   },
   {
     path: "/playlist/:id",
     name: "playlist",
-    component: () => import("@/views/playlist"),
+    component: () => import("@/views/playlist.vue"),
   },
   {
     path: "/album/:id",
     name: "album",
-    component: () => import("@/views/album"),
+    component: () => import("@/views/album.vue"),
   },
   {
     path: "/artist/:id",
     name: "artist",
-    component: () => import("@/views/artist"),
+    component: () => import("@/views/artist.vue"),
     meta: {
       keepAlive: true,
     },
@@ -53,12 +53,12 @@ const routes = [
   {
     path: "/mv/:id",
     name: "mv",
-    component: () => import("@/views/mv"),
+    component: () => import("@/views/mv.vue"),
   },
   {
     path: "/next",
     name: "next",
-    component: () => import("@/views/next"),
+    component: () => import("@/views/next.vue"),
     meta: {
       keepAlive: true,
     },
@@ -66,17 +66,17 @@ const routes = [
   {
     path: "/search",
     name: "search",
-    component: () => import("@/views/search"),
+    component: () => import("@/views/search.vue"),
   },
   {
     path: "/new-album",
     name: "newAlbum",
-    component: () => import("@/views/newAlbum"),
+    component: () => import("@/views/newAlbum.vue"),
   },
   {
     path: "/explore",
     name: "explore",
-    component: () => import("@/views/explore"),
+    component: () => import("@/views/explore.vue"),
     meta: {
       keepAlive: true,
     },
@@ -84,7 +84,7 @@ const routes = [
   {
     path: "/library",
     name: "library",
-    component: () => import("@/views/library"),
+    component: () => import("@/views/library.vue"),
     meta: {
       requireLogin: true,
       keepAlive: true,
@@ -93,7 +93,7 @@ const routes = [
   {
     path: "/library/liked-songs",
     name: "likedSongs",
-    component: () => import("@/views/playlist"),
+    component: () => import("@/views/playlist.vue"),
     meta: {
       requireLogin: true,
     },
@@ -101,7 +101,7 @@ const routes = [
   {
     path: "/settings",
     name: "settings",
-    component: () => import("@/views/settings"),
+    component: () => import("@/views/settings.vue"),
   },
 ];
 const router = new VueRouter({
@@ -116,17 +116,15 @@ const router = new VueRouter({
 });
 
 router.beforeEach((to, from, next) => {
+  // 需要登录的逻辑
   if (to.meta.requireLogin) {
     if (store.state.settings.user.nickname === undefined) {
       next({ path: "/login" });
     }
-    if (
-      Cookies.get("MUSIC_U") === undefined &&
-      Cookies.get("loginMode") === "account"
-    ) {
-      next({ path: "/login" });
-    } else {
+    if (isLooseLoggedIn()) {
       next();
+    } else {
+      next({ path: "/login" });
     }
   } else {
     next();
diff --git a/src/store/actions.js b/src/store/actions.js
index 58d0b2b..6a28df9 100644
--- a/src/store/actions.js
+++ b/src/store/actions.js
@@ -1,6 +1,6 @@
 import { updateMediaSessionMetaData } from "@/utils/mediaSession";
 import { getTrackDetail, scrobble, getMP3 } from "@/api/track";
-import { isLoggedIn } from "@/utils/auth";
+import { isAccountLoggedIn } from "@/utils/auth";
 import { updateHttps } from "@/utils/common";
 
 export default {
@@ -41,8 +41,7 @@ export default {
           dispatch("nextTrack");
         });
       }
-
-      if (isLoggedIn) {
+      if (isAccountLoggedIn()) {
         getMP3(track.id).then((data) => {
           // 未知情况下会没有返回数据导致报错，增加防范逻辑
           if (data.data[0]) {
diff --git a/src/store/mutations.js b/src/store/mutations.js
index 6f5ca35..2e4b811 100644
--- a/src/store/mutations.js
+++ b/src/store/mutations.js
@@ -81,6 +81,16 @@ export default {
       return track;
     });
   },
+  updateAccountLogin(state, status) {
+    state.accountLogin = status;
+  },
+  updateUsernameLogin(state, status) {
+    state.usernameLogin = status;
+  },
+  updateLogout() {
+    this.commit("updateAccountLogin", false);
+    this.commit("updateUsernameLogin", false);
+  },
   updateUser(state, user) {
     state.settings.user = user;
   },
diff --git a/src/store/state.js b/src/store/state.js
index d2d5dfd..925e46f 100644
--- a/src/store/state.js
+++ b/src/store/state.js
@@ -9,4 +9,6 @@ export default {
   },
   player: JSON.parse(localStorage.getItem("player")),
   settings: JSON.parse(localStorage.getItem("settings")),
+  accountLogin: false,
+  usernameLogin: false,
 };
diff --git a/src/utils/auth.js b/src/utils/auth.js
index 239ddcb..eb3c9bb 100644
--- a/src/utils/auth.js
+++ b/src/utils/auth.js
@@ -4,10 +4,38 @@ import store from "@/store";
 
 export function doLogout() {
   logout();
+  // 移除前端本地用来认证登录的字段
   Cookies.remove("loginMode");
+  // 网易云的接口会自动移除该 cookies
+  // Cookies.remove("MUSIC_U");
+  // 更新状态仓库中的用户信息
   store.commit("updateUser", { id: 0 });
+  // 更新状态仓库中的登录状态
+  store.commit("updateLogout");
 }
 
+// MUSIC_U 只有在账户登录的情况下才有
 export function isLoggedIn() {
   return Cookies.get("MUSIC_U") !== undefined ? true : false;
 }
+
+// 账号登录
+export function isAccountLoggedIn() {
+  return (
+    Cookies.get("MUSIC_U") !== undefined &&
+    Cookies.get("loginMode") === "account"
+  );
+}
+
+// 用户名搜索（用户数据为只读）
+export function isUsernameLoggedIn() {
+  return (
+    Cookies.get("MUSIC_U") === undefined &&
+    Cookies.get("loginMode") === "username"
+  );
+}
+
+// 账户登录或者用户名搜索都判断为登录，宽松检查
+export function isLooseLoggedIn() {
+  return isAccountLoggedIn() || isUsernameLoggedIn();
+}
diff --git a/src/utils/common.js b/src/utils/common.js
index 575e634..f94b8bc 100644
--- a/src/utils/common.js
+++ b/src/utils/common.js
@@ -1,4 +1,4 @@
-import { isLoggedIn } from "./auth";
+import { isAccountLoggedIn } from "./auth";
 import store from "@/store";
 
 export function isTrackPlayable(track) {
@@ -7,7 +7,7 @@ export function isTrackPlayable(track) {
     reason: "",
   };
   if (track.fee === 1 || track.privilege?.fee === 1) {
-    if (isLoggedIn && store.state.settings.user.vipType === 11) {
+    if (isAccountLoggedIn() && store.state.settings.user.vipType === 11) {
       result.playable = true;
     } else {
       result.playable = false;
diff --git a/src/views/album.vue b/src/views/album.vue
index 4c9f472..9cbb66b 100644
--- a/src/views/album.vue
+++ b/src/views/album.vue
@@ -60,8 +60,8 @@
         More by
         <router-link :to="`/artist/${album.artist.id}`"
           >{{ album.artist.name }}
-        </router-link></div
-      >
+        </router-link>
+      </div>
       <div>
         <CoverRow
           type="album"
diff --git a/src/views/loginAccount.vue b/src/views/loginAccount.vue
index 2958bc0..3c00d30 100644
--- a/src/views/loginAccount.vue
+++ b/src/views/loginAccount.vue
@@ -112,9 +112,9 @@ export default {
     NProgress.done();
   },
   methods: {
-    ...mapMutations(["updateUser", "updateUserInfo"]),
+    ...mapMutations(["updateUser", "updateUserInfo", "updateAccountLogin"]),
     afterLogin() {
-      // Cookies.set("MUSIC_U", true, { expires: 3650 });
+      this.updateAccountLogin(true);
       Cookies.set("loginMode", "account", { expires: 3650 });
       userPlaylist({
         uid: this.$store.state.settings.user.userId,
@@ -127,18 +127,34 @@ export default {
         this.$router.push({ path: "/library" });
       });
     },
+    validatePhone() {
+      if (
+        this.countryCode === "" ||
+        this.phone === "" ||
+        this.password === ""
+      ) {
+        alert("国家区号、手机或密码不正确");
+        this.processing = false;
+        return false;
+      }
+      return true;
+    },
+    validateEmail() {
+      const emailReg = /^[A-Za-z0-9]+([_][A-Za-z0-9]+)*@([A-Za-z0-9]+\.)+[A-Za-z]{2,6}$/;
+      if (
+        this.email === "" ||
+        this.password === "" ||
+        !emailReg.test(this.email)
+      ) {
+        alert("邮箱或密码不正确");
+        return false;
+      }
+      return true;
+    },
     login() {
       this.processing = true;
       if (this.mode === "phone") {
-        if (
-          this.countryCode === "" ||
-          this.phone === "" ||
-          this.password === ""
-        ) {
-          alert("国家区号、手机或密码不正确");
-          this.processing = false;
-          return;
-        }
+        this.processing = this.validatePhone();
         loginWithPhone({
           countrycode: this.countryCode.replace("+", "").replace(/\s/g, ""),
           phone: this.phoneNumber.replace(/\s/g, ""),
@@ -156,16 +172,7 @@ export default {
             alert(error);
           });
       } else {
-        let emailReg = /^[A-Za-z0-9]+([_][A-Za-z0-9]+)*@([A-Za-z0-9]+\.)+[A-Za-z]{2,6}$/;
-        if (
-          this.email === "" ||
-          this.password === "" ||
-          !emailReg.test(this.email)
-        ) {
-          alert("邮箱或密码不正确");
-          this.processing = false;
-          return;
-        }
+        this.processing = this.validateEmail();
         loginWithEmail({
           email: this.email.replace(/\s/g, ""),
           password: "fakePassword",
diff --git a/src/views/loginUsername.vue b/src/views/loginUsername.vue
index 0ffd895..0f95205 100644
--- a/src/views/loginUsername.vue
+++ b/src/views/loginUsername.vue
@@ -41,8 +41,9 @@
       <ButtonTwoTone
         @click.native="confirm"
         v-show="activeUser.nickname !== undefined"
-        >{{ $t("login.confirm") }}</ButtonTwoTone
       >
+        {{ $t("login.confirm") }}
+      </ButtonTwoTone>
     </div>
   </div>
 </template>
@@ -73,7 +74,7 @@ export default {
     NProgress.done();
   },
   methods: {
-    ...mapMutations(["updateUser", "updateUserInfo"]),
+    ...mapMutations(["updateUser", "updateUserInfo", "updateUsernameLogin"]),
     search() {
       if (!this.keyword) return;
       search({ keywords: this.keyword, limit: 9, type: 1002 }).then((data) => {
@@ -83,6 +84,7 @@ export default {
     },
     confirm() {
       this.updateUser(this.activeUser);
+      this.updateUsernameLogin(true);
       Cookies.set("loginMode", "username", { expires: 3650 });
       userPlaylist({
         uid: this.activeUser.userId,
diff --git a/src/views/playlist.vue b/src/views/playlist.vue
index cf3d9c2..f7a6e59 100644
--- a/src/views/playlist.vue
+++ b/src/views/playlist.vue
@@ -46,7 +46,7 @@
           </ButtonTwoTone>
           <ButtonTwoTone
             v-if="
-              isLoggedIn && playlist.creator.userId !== settings.user.userId
+              accountLogin && playlist.creator.userId !== settings.user.userId
             "
             shape="round"
             :iconClass="playlist.subscribed ? 'heart-solid' : 'heart'"
@@ -92,7 +92,6 @@ import NProgress from "nprogress";
 import { getPlaylistDetail, subscribePlaylist } from "@/api/playlist";
 import { playAList } from "@/utils/play";
 import { getTrackDetail } from "@/api/track";
-import { isLoggedIn } from "@/utils/auth";
 
 import ButtonTwoTone from "@/components/ButtonTwoTone.vue";
 import TrackList from "@/components/TrackList.vue";
@@ -132,10 +131,7 @@ export default {
     window.removeEventListener("scroll", this.handleScroll, true);
   },
   computed: {
-    ...mapState(["player", "settings"]),
-    isLoggedIn() {
-      return isLoggedIn();
-    },
+    ...mapState(["player", "settings", "accountLogin"]),
     isLikeSongsPage() {
       return this.$route.name === "likedSongs";
     },