🏠 返回首頁 

Greasy Fork is available in English.

lyricUtils v2

helpful utilities when working with song lyrics and OpenSong


安装此脚本?
  1. // ==UserScript==
  2. // @name lyricUtils v2
  3. // @namespace Violentmonkey Scripts
  4. // @include https://www.azlyrics.com/lyrics/*
  5. // @include https://www.letras.com/*
  6. // @include https://4334.sk/*
  7. // @include https://www.songlyrics.com/*
  8. // @include https://www.lyrics.com/track/*
  9. // @include https://www.lyrics.com/lyric-lf/*
  10. // @include https://bethelmusic.com/chords-and-lyrics/*
  11. // @include https://genius.com/*
  12. // @grant none
  13. // @version 2.7.2
  14. // @author KraXen72
  15. // @locale en-US
  16. // @license GPLv3
  17. // @description helpful utilities when working with song lyrics and OpenSong
  18. // ==/UserScript==
  19. console.log("lyricUtils v2 loaded.")
  20. let site = {
  21. n: "", // name
  22. querySelector: "", // where to get text from
  23. holderqs: "", // where to inject our versed div, other: overwrite, headonly
  24. textKey: "", // what to use to get text (for exampe innerText or textContent)
  25. advancedVers###pport: false, // if the site gives info about which verse is chorus, which is bridge, etc
  26. verseHeadings: [], // if custom verse heading are provided (geinus, bethel, ...) they will be saved here
  27. parsedVerseHeadings: []
  28. }
  29. // sites are expected to handle adding to site.verseHeadings themselves in either their extractor or in groupToVerses if absolutely neccessary
  30. const TempText = document.createElement("textarea");
  31. const defaultElemStyleObj = {
  32. padding: ".5rem",
  33. border: "2px solid darkblue",
  34. borderRadius: "5px",
  35. margin: "0 .25rem",
  36. height: "40px",
  37. width: "40px",
  38. boxSizing: "border-box",
  39. }
  40. function determineSite() {
  41. //console.log(window.location.hostname)
  42. switch (window.location.hostname) {
  43. case "4334.sk":
  44. site.n = "4334";
  45. site.holderqs = ".entry-content"
  46. break;
  47. case "www.letras.com":
  48. site.n = "letras";
  49. site.querySelector = ".cnt-letra.p402_premium"
  50. site.holderqs = "overwrite"
  51. site.textKey = "innerText"
  52. break;
  53. case "www.azlyrics.com":
  54. site.n = "azlyrics";
  55. site.querySelector = ".col-xs-12.col-lg-8.text-center div:not([class]):not([id])";
  56. site.holderqs = ".col-xs-12.col-lg-8.text-center"
  57. site.textKey = "textContent"
  58. break;
  59. case "www.songlyrics.com":
  60. site.n = "songlyrics"
  61. site.querySelector = "#songLyricsDiv"
  62. site.holderqs = "overwrite"
  63. site.textKey = "textContent"
  64. break;
  65. case "www.lyrics.com":
  66. site.n = "lyricscom"
  67. site.querySelector = "#lyric-body-text"
  68. site.holderqs = "overwrite"
  69. site.textKey = "innerText"
  70. break;
  71. case "bethelmusic.com":
  72. site.n = "bethel"
  73. site.holderqs = "#tabLyrics"
  74. site.textKey = "innerText"
  75. site.advancedVers###pport = true // bethel has bold
  76. //TODO remove double/triple newlines
  77. break;
  78. case "genius.com":
  79. site.n = "genius"
  80. site.querySelector = 'div[data-lyrics-container="true"]'
  81. site.holderqs = "headonly"
  82. site.textKey = "innerText"
  83. site.advancedVers###pport = true // genius has [Verse]
  84. break;
  85. default:
  86. console.error(`unknown site ${window.location.hostname}`);
  87. }
  88. }
  89. function injectCSS(css) {
  90. const styleTag = document.createElement("style")
  91. styleTag.innerHTML = css
  92. document.head.appendChild(styleTag)
  93. }
  94. function makeBtn(text, onclick) {
  95. const btn = document.createElement("button")
  96. btn.classList.add("lyricUtils-button")
  97. Object.assign(btn.style, defaultElemStyleObj)
  98. btn.onclick = onclick
  99. btn.textContent = text
  100. return btn
  101. }
  102. function copyMe(textToCopy) {
  103. TempText.value = textToCopy;
  104. //TempText.style.display = "none"
  105. document.body.appendChild(TempText);
  106. TempText.select();
  107. document.execCommand("copy");
  108. document.body.removeChild(TempText);
  109. console.log("copied stuff", textToCopy)
  110. }
  111. // utility functions
  112. const bare = (s) => s.trim().replaceAll(" ", "") // bare string: no whitespace, no spaces
  113. const elem = (qs) => { // querySelector, but if qs is already an element just pass it on
  114. if (typeof qs === "string") return document.querySelector(qs)
  115. return qs
  116. }
  117. const text = (qs, key) => elem(qs)[key] // elem + get text by key
  118. const textAll = (qs, key) => {
  119. if (typeof qs === "string") return [...document.querySelectorAll(qs)].map(elem => elem[key]).join("\n")
  120. return qs[key]
  121. }
  122. // group plaintext into array of verses, depending on newlines & other context
  123. function groupToVerses(text) {
  124. const lines = text.split("\n")
  125. const newLines = [...lines]
  126. .filter(l => l !== "Hide Chords")
  127. .filter((line, i, arr) => { // remove multiple newlines after each other
  128. if (i > 0 && bare(line) === "" && bare(arr[i - 1]) === "") { return false } else { return true }
  129. })
  130. console.log("debug newlines", newLines)
  131. // first filter is to filter out Hide Chords, seconds is multiple newlines.
  132. // i tried to filter both in one pass but then "" "Hide Chords" "" doesen't get recognized as "" "" bc i shifts
  133. let verses = [""] // starts with empty verse
  134. for (let i = 0; i < newLines.length; i++) {
  135. const l = newLines[i]
  136. if (site.n === "genius" ? l.startsWith("[") && l.endsWith("]") : l === "" ) {
  137. if (site.n === "genius") site.verseHeadings.push(l)
  138. verses.push("") // start a new verse
  139. } else if (l.startsWith(" ")) { // if a thing like " (What?)" is on new line, after annotation.
  140. verses[verses.length - 1] = verses[verses.length - 1].slice(0, -4) + l + "<br>"
  141. } else {
  142. verses[verses.length - 1] += l + "<br>" // continue an existing verse
  143. }
  144. }
  145. verses = verses.filter(v => v.replaceAll("<br>", "").trim() !== "") // filter out empty verses
  146. console.log("verses after filter:", verses)
  147. return verses
  148. }
  149. // FIXME genius still separates verses by multiple newlines
  150. // get all text for copying
  151. function getTextContent() {
  152. let stuff = ""
  153. const newHolder = document.getElementById("lyricUtils-holder")
  154. Array.from(newHolder.children).forEach(child => {
  155. if (site.n === "genius") {
  156. if (!(child.classList.contains("lyricUtils-button")) && child.id !== "lyricUtils-stateDiv") {
  157. child.innerHTML
  158. .split("<br>")
  159. .filter((item, i, arr) => item.trim() !== "" || i === arr.length - 1)
  160. .forEach((line, i, arr) => stuff += line.replaceAll("&amp;", "&") + "\n")
  161. }
  162. } else {
  163. if (!(child.classList.contains("lyricUtils-button")) && child.id !== "lyricUtils-stateDiv") stuff += child.innerText
  164. if (child.classList.contains("lyricUtils-vhead") || child.classList.contains("lyricUtils-verse")) stuff += "\n"
  165. }
  166. })
  167. console.log("tocopy", stuff)
  168. return stuff
  169. }
  170. // transform headers in words like "Verse 1" into "[V1]"
  171. function ensureResolveOpensongHeaders() {
  172. if (site.parsedVerseHeadings.length > 0) return // already parsed
  173. if (site.verseHeadings.length === 0) return; // no support
  174. if (site.advancedVers###pport === false) return; // no support
  175. site.verseHeadings = site.verseHeadings.map(h => bare(h.replaceAll("[", "").replaceAll("]", "")))
  176. const verseHeadingsCounter = { verse: 0, chorus: 0, bridge: 0 }
  177. const _opensongTag = ( tag = "V", type = "verse") => {
  178. // only one of this tag per song, no need for number (except verse)
  179. if (type !== "verse" && site.verseHeadings.filter(h => h.toLowerCase().startsWith(type)).length === 1) {
  180. verseHeadingsCounter[type] += 1
  181. return `${tag}`
  182. } else {
  183. verseHeadingsCounter[type] += 1
  184. return `${tag}${verseHeadingsCounter[type]}`
  185. }
  186. }
  187. site.parsedVerseHeadings = site.verseHeadings
  188. .map((h, i) => {
  189. if (h.startsWith("Verse")) return _opensongTag("V", "verse")
  190. if (h.startsWith("Bridge")) return _opensongTag("B", "bridge")
  191. if (h.startsWith("Chorus")) return _opensongTag("C", "chorus")
  192. if (h.startsWith("Refrain")) return _opensongTag("C", "chorus")
  193. verseHeadingsCounter.verse += 1
  194. return `V${i + 1}`
  195. })
  196. }
  197. // function that either returns V1 - VXX, or if site.verseHeadings is defined, parse that and return more specific opensong headers
  198. function makeOpensongHeader(index) {
  199. if (!site.advancedVers###pport || site.advancedVers###pport && site.verseHeadings.length === 0) {
  200. return `V${index + 1}` }
  201. else {
  202. ensureResolveOpensongHeaders()
  203. return site.parsedVerseHeadings[index]
  204. }
  205. }
  206. // make the actual div elements to host our text
  207. function constructVerseElement(verses) {
  208. const holder = document.createElement("div")
  209. holder.id = "lyricUtils-holder"
  210. verses.forEach((v, index, arr) => {
  211. const vDiv = document.createElement("div")
  212. vDiv.id = `${makeOpensongHeader(index)}-lyricUtils`
  213. vDiv.classList.add("lyricUtils-verse")
  214. vDiv.innerHTML = v
  215. holder.appendChild(vDiv)
  216. if (index !== arr.length -1) holder.appendChild(document.createElement("br"))
  217. })
  218. return holder
  219. }
  220. function addHeaders() {
  221. if (document.querySelector(".lyricUtils-vhead") === null) {
  222. const allVerses = [...document.getElementsByClassName("lyricUtils-verse")]
  223. const newHolder = document.getElementById("lyricUtils-holder")
  224. allVerses.forEach(verse => {
  225. const vHead = document.createElement("div")
  226. vHead.classList.add("lyricUtils-vhead")
  227. vHead.textContent = `[${verse.id.split("-")[0]}]` // VXX-lyricUtils => [VXX]
  228. newHolder.insertBefore(vHead, verse)
  229. })
  230. document.getElementById("lyricUtils-stateDiv").style.background = "lightgreen"
  231. } else {
  232. console.log("did nothing, headers are already added")
  233. }
  234. }
  235. function removeHeaders() {
  236. [...document.getElementsByClassName("lyricUtils-vhead")].forEach(head => head.remove())
  237. document.getElementById("lyricUtils-stateDiv").style.background = ""
  238. }
  239. // transparent modifier function
  240. function transModFn(value, debug = false) {
  241. if (debug) console.log(`fn-debug:`, value)
  242. return value
  243. }
  244. const extractors = {
  245. // there are a bunch of mod function that can modify some part of the process, if needed
  246. // by default they are set to transModFn, which just passes through the value
  247. _standard: (qs, key, modTextFn = transModFn, modVerseFn = transModFn, modElemFn = transModFn) => {
  248. const rawText = modTextFn( text(qs, key) )
  249. const verses = modVerseFn( groupToVerses(rawText) )
  250. const ourElement = modElemFn( constructVerseElement(verses) )
  251. if (site.holderqs === "overwrite") {
  252. elem(site.querySelector).innerHTML = ourElement.innerHTML
  253. elem(site.querySelector).id = "lyricUtils-holder" //has to go second, because qs can be an id selector
  254. } else if (site.holderqs === "headonly") {
  255. const holder = elem(site.querySelector).parentElement
  256. injectCSS(`.lyricUtils-verse { display: none; }`)
  257. holder.insertBefore(ourElement, elem(site.querySelector))
  258. } else {
  259. const holder = document.querySelector(site.holderqs)
  260. holder.insertBefore(ourElement, elem(site.querySelector).nextElementSibling)
  261. }
  262. const stateElem = Object.assign(document.createElement("button"), { id: "lyricUtils-stateDiv", innerHTML: "🆚", title: "green = opensong verse headings [V1], [V2], ... are added"})
  263. Object.assign(stateElem.style, {...defaultElemStyleObj, cursor: "default" })
  264. const newHolder = document.getElementById("lyricUtils-holder")
  265. newHolder.prepend(stateElem)
  266. newHolder.prepend(makeBtn("📋", () => { copyMe(getTextContent()) }))
  267. newHolder.prepend(makeBtn("⛔", removeHeaders))
  268. newHolder.prepend(makeBtn("➕", addHeaders))
  269. injectCSS(`.lyricUtils-button:hover { background-color: rgba(0,0,0,0.2) }`)
  270. console.log("everything ran.", site.n, site.parsedVerseHeadings)
  271. },
  272. azlyrics: () => {
  273. injectCSS(`
  274. ${site.querySelector} { display: none !important; }
  275. .lyricUtils-button, #lyricUtils-stateDiv { margin-bottom: 1.2rem !important; }
  276. `)
  277. extractors._standard(site.querySelector, site.textKey)
  278. },
  279. letras: () => {
  280. injectCSS(`#player { display: none !important; } ::selection { background: #dcdc00 !important; }`);
  281. extractors._standard(site.querySelector, site.textKey)
  282. },
  283. 4334: () => {
  284. injectCSS(`
  285. div[style*="visibility: visible; position: absolute;"] { display: none !important; }
  286. .entry-content { display: flex; flex-direction: row-reverse; justify-content: space-between }
  287. .site-navigation-inner .searchform input, { width: 200px !important; padding-left: 10px !important; transition: all 0s !important; }
  288. .site-navigation-inner .searchform.active { margin-left: 0px !important }
  289. `)
  290. // fix up stuff for copying: 4334 has chord divs in the text
  291. const clonedText = document.querySelector(".chordwp-container").cloneNode(true)
  292. const wrappers = [...clonedText.querySelectorAll(".chwp-lyrics-row-wrapper")]
  293. lines = []
  294. wrappers.forEach(w => {
  295. const lyr = [...w.querySelectorAll(".chwp-lyrics")]
  296. let txt = []
  297. lyr.forEach(l => txt.push(l.textContent))
  298. lines.push(`<div class="line">${txt.join("")}</div>`)
  299. if (w.nextElementSibling && w.nextElementSibling.tagName === "BR") lines.push(`<div class="line"><br></div>`)
  300. })
  301. clonedText.innerHTML = lines.join("\n")
  302. site.querySelector = clonedText
  303. site.textKey = "innerText"
  304. extractors._standard(site.querySelector, site.textKey)
  305. },
  306. songlyrics: () => {
  307. injectCSS(`
  308. .iComment-popup { display: none !important; pointer-events: none !important; }
  309. #lyricUtils-holder { font-size: 16px; line-height: 1.6; }
  310. `)
  311. extractors._standard(site.querySelector, site.textKey)
  312. },
  313. lyricscom: () => {
  314. extractors._standard(site.querySelector, site.textKey)
  315. },
  316. genius: () => {
  317. injectCSS(`
  318. #lyricUtils-holder { grid-column: left-start / left-end; height: 2.1rem !important; min-height:0 !important; position: absolute; top: 12px; right: 0}
  319. .fdEmdh, .lyricUtils-vhead { display: none; }
  320. `)
  321. // overwrite the text getter to use querySelectorAll
  322. extractors._standard(site.querySelector, site.textKey, () => textAll(site.querySelector, site.textKey))
  323. },
  324. bethel: () => {
  325. injectCSS(`
  326. #tabLyrics { display: grid; grid-template: auto / max-content max-content auto; column-gap: 1rem; }
  327. #lyricUtils-holder { font-size: 16px; line-height: 20px; grid-colum: 2 / 3 }
  328. #tabLyrics .content { grid-colum: 1 / 2 }
  329. .nav.nav-tabs { display: none !important; poiner-events: none; }
  330. `)
  331. const lyricsDiv = document.createElement("div")
  332. lyricsDiv.innerHTML = document.querySelector("#tabLyrics .content").innerHTML
  333. const bTags = [...lyricsDiv.querySelectorAll("p > b")]
  334. bTags.forEach(b => {
  335. site.verseHeadings.push(b.textContent)
  336. b.remove()
  337. })
  338. site.querySelector = lyricsDiv
  339. extractors._standard(lyricsDiv, site.textKey)
  340. }
  341. }
  342. console.log("lyricUtils v2 initialized.")
  343. determineSite()
  344. extractors[site.n]()
  345. console.log("lyricUtils v2 executed.")