{"id":1862,"date":"2017-11-20T11:37:03","date_gmt":"2017-11-20T10:37:03","guid":{"rendered":"https:\/\/blog.kodono.info\/wordpress\/?p=1862"},"modified":"2018-12-03T12:24:45","modified_gmt":"2018-12-03T11:24:45","slug":"how-to-delete-a-document-locked-by-another-user-in-sharepoint-using-javascript","status":"publish","type":"post","link":"https:\/\/blog.kodono.info\/wordpress\/2017\/11\/20\/how-to-delete-a-document-locked-by-another-user-in-sharepoint-using-javascript\/","title":{"rendered":"How to delete a document locked by another user in Sharepoint using JavaScript"},"content":{"rendered":"

When you open a file from Sharepoint, it will receive a short term lock that will prevent others to change some properties on the file.<\/p>\n

This protection can be useful, but also very annoying, for example when the file is not closed properly, then the lock could stay “forever”.<\/p>\n

There are many<\/a> posts<\/a> on<\/a> the web<\/a> about it.<\/p>\n

I found one that has been super useful: https:\/\/pholpar.wordpress.com\/2014\/04\/07\/how-to-use-javascript-to-delete-short-term-locks-from-documents-opened-from-sharepoint\/<\/a>
\nThe author explains very well the different steps what I’m trying to summarize:<\/p>\n

    \n
  1. Send a request to _vti_bin\/_vti_aut\/author.dll<\/code> with special headers\/body<\/li>\n
  2. Auth.dll will provide the lockid<\/code><\/li>\n
  3. Send a request to _vti_bin\/cellstorage.svc\/CellStorageService<\/code> with special headers\/body, included the lockid<\/code><\/li>\n
  4. The file is unlocked<\/li>\n<\/ol>\n

    The code to send to CellStorageService, and provided by the author, didn’t work for me. I’ve had to use Fiddler and open the document into Office on my computer to see the kind of requests send by it to unlock a document. Based on it, I’ve re-built the code and you can find my solution below.<\/p>\n

    Tested on Sharepoint 2013 On-Promise only. I don’t know if this solution works for Sharepoint Online or other version.
    \nAlso note that I use $SP().ajax()<\/code> from     SharepointPlus<\/a>, but it’s equivalent to the $.ajax<\/code> from jQuery.<\/p>\n

    \r\n\/\/ full path to the document\r\nvar docUrl = \"https:\/\/website.com\/website\/Doc_Library\/Test.docx\";\r\n\r\n\/\/ start by querying author.dll to find the lockid and the user who locked it\r\n$SP().ajax({\r\n  url: 'https:\/\/website.com\/website\/_vti_bin\/_vti_aut\/author.dll',\r\n  headers:{\r\n    \"Content-Type\": \"application\/x-www-form-urlencoded\",\r\n    \"MIME-Version\": \"1.0\",\r\n    \"Accept\": \"auth\/sicily\",\r\n    \"X-Vermeer-Content-Type\": \"application\/x-www-form-urlencoded\"\r\n  },\r\n  body: 'method=getDocsMetaInfo%3a14%2e0%2e0%2e6009&url%5flist=%5b' + encodeURIComponent(docUrl) + '%5d&listHiddenDocs=false&listLinkInfo=false',\r\n}).then(function(source) {\r\n  \/\/ go thru the source page returned to find the lockid and current user\r\n  var nextLine = false;\r\n  var ret = { \"lockid\":\"\", \"user\":\"\", when:\"\" };\r\n  source.split(\"\\n\").forEach(function(line) {\r\n    if (line.indexOf(\"vti_sourcecontrollockid\") !== -1) nextLine=\"lockid\"; \/\/ vti_sourcecontrollockid -> the lockid to use later\r\n    else if (line.indexOf(\"vti_sourcecontrolcheckedoutby\") !== -1) nextLine=\"user\"; \/\/ vti_sourcecontrolcheckedoutby -> username of the user who locked it\r\n    else if (line.indexOf(\"vti_sourcecontrollockexpires\") !== -1) nextLine=\"when\"; \/\/ vti_sourcecontrollockexpires -> when the server is supposed to unlock it\r\n    else if (nextLine !== false) {\r\n      ret[nextLine] = line.slice(7).replace(\/&#([0-9]|[1-9][0-9]|[[01][0-9][0-9]|2[0-4][0-9]|25[0-5]);\/g, function (str, match) { return  String.fromCharCode(match); });\r\n      nextLine = false;\r\n    }\r\n  });\r\n\r\n  if (!ret.lockid) { alert(\"Not Locked\") }\r\n  else {\r\n    \/\/ compose a request based on what Microsoft Office sends to the Sharepoint server\r\n    \/\/ found using Fiddler\r\n    var releaseLockReq = '<s:Envelope xmlns:s=\"http:\/\/schemas.xmlsoap.org\/soap\/envelope\/\"><s:Body><RequestVersion Version=\"2\" MinorVersion=\"2\" xmlns=\"http:\/\/schemas.microsoft.com\/sharepoint\/soap\/\"\/><RequestCollection CorrelationId=\"{96A244BD-D13B-4696-9355-231FB673BC4F}\" xmlns=\"http:\/\/schemas.microsoft.com\/sharepoint\/soap\/\"><Request Url=\"'+docUrl+'\" UseResourceID=\"true\" UserAgent=\"{1984108C-4B93-4EEB-B320-919432D6E593}\" UserAgentClient=\"msword\" UserAgentPlatform=\"win\" Build=\"16.0.8201.2102\" MetaData=\"1031\" RequestToken=\"1\"><SubRequest Type=\"ExclusiveLock\" SubRequestToken=\"1\"><SubRequestData ExclusiveLockRequestType=\"ReleaseLock\" ExclusiveLockID=\"'+ret.lockid+'\"\/><\/SubRequest><\/Request><\/RequestCollection><\/s:Body><\/s:Envelope>';\r\n\r\n    \/\/ we send it to the webservice cellstorage.svc\r\n    $SP().ajax({\r\n      url:'https:\/\/website.com\/website\/_vti_bin\/cellstorage.svc\/CellStorageService',\r\n      body:releaseLockReq,\r\n      headers:{\r\n        'Content-Type':'text\/xml; charset=UTF-8',\r\n        'SOAPAction': \"http:\/\/schemas.microsoft.com\/sharepoint\/soap\/ICellStorages\/ExecuteCellStorageRequest\"\r\n      }\r\n    })\r\n    .then(function(res) {\r\n      if (res.indexOf('ErrorCode=\"Success\"') !== -1) alert(\"Success\") \/\/ the file has been unlocked\r\n      else alert(\"Failed\")\r\n    })\r\n  }\r\n})\r\n<\/pre>\n
    I hope it will be useful to someone else!<\/p>\n","protected":false},"excerpt":{"rendered":"
    When you open a file from Sharepoint, it will receive a short term lock that will prevent others to change some properties on the file. This protection can be useful, but also very annoying, for example when the file is not closed properly, then the lock could stay “forever”. There are many posts on the […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_coblocks_attr":"","_coblocks_dimensions":"","_coblocks_responsive_height":"","_coblocks_accordion_ie_support":"","hide_page_title":"","footnotes":""},"categories":[170,20,33],"tags":[123,24,155,158,117],"class_list":["post-1862","post","type-post","status-publish","format-standard","hentry","category-english","category-niveau-expert","category-programmation","tag-english","tag-javascript","tag-niveau-expert","tag-programmation","tag-sharepoint"],"_links":{"self":[{"href":"https:\/\/blog.kodono.info\/wordpress\/wp-json\/wp\/v2\/posts\/1862","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/blog.kodono.info\/wordpress\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blog.kodono.info\/wordpress\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blog.kodono.info\/wordpress\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/blog.kodono.info\/wordpress\/wp-json\/wp\/v2\/comments?post=1862"}],"version-history":[{"count":7,"href":"https:\/\/blog.kodono.info\/wordpress\/wp-json\/wp\/v2\/posts\/1862\/revisions"}],"predecessor-version":[{"id":1922,"href":"https:\/\/blog.kodono.info\/wordpress\/wp-json\/wp\/v2\/posts\/1862\/revisions\/1922"}],"wp:attachment":[{"href":"https:\/\/blog.kodono.info\/wordpress\/wp-json\/wp\/v2\/media?parent=1862"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blog.kodono.info\/wordpress\/wp-json\/wp\/v2\/categories?post=1862"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blog.kodono.info\/wordpress\/wp-json\/wp\/v2\/tags?post=1862"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}