US20120254315A1 - Caching infrastructure - Google Patents

Abstract

Example systems and methods are directed at maintaining and retrieving presence metadata. One example method includes receiving a request from a first client to edit a document file, and sending short-term check out metadata to the first client to begin an editing session. The method also includes writing the transition ID to a transition table stored in a cache, wherein the presence of another transition ID in the cache indicates that a document has switched from a single-client mode to a multi-client mode. An example system includes a processing unit operative to receive a document, the document including short-term check out metadata indicating an editing session has begun, ping a cache to determine if another transition ID is stored in the cache, and send a transition ID to a transition table stored in a cache to switch from a single-client mode to a multi-client mode.

Description

BACKGROUND
• In a collaborative environment, some computer applications allow multiple clients to simultaneously edit a document. As multiple clients are editing the document, a server may maintain a copy of the document. The server may need to continually update the copy of the document to reflect the current state of the document. This can lead to inefficiencies.
• For example, even with only a single client editing the document, the client's application may need to continuously update the server to allow the transition to multi-party editing when it occurs. This can increase server load, thereby causing a degradation in performance.
SUMMARY
• Example systems and methods described herein relate to a caching infrastructure.
• According to one aspect, an example method for retrieval of presence metadata includes: receiving a request from a first client to edit a document file; sending short-term check out metadata to the first client to begin an editing session; and writing the transition ID to a transition table stored in a cache, wherein the presence of another transition ID in the cache indicates that a document has switched from a single-client mode to a multi-client mode.
• According to another aspect, an example system includes a cache infrastructure for retrieval of presence metadata. The system includes a memory storage unit, and a processing unit coupled to the memory storage unit, wherein the processing unit is operative to receive short-term check out metadata from a first client to begin an editing session, add a transition ID to the short-term check out metadata, write the transition ID to a transition table stored in a cache, and switch from a single-client mode to a multi-client mode. Switching from the single-client mode to the multi-client mode comprises the processing unit being operative to notice when the first client attempts to take another short-term lock on the document and seeing that that a second client has already received the document. The processing unit is operative to determine if the multi-client mode is in progress by checking a database, receive a ping from the first client to determine if the transition ID is in the cache, and when the transition ID is not in the cache, receive pings from the first client at regular intervals, and save the document to the server a plurality of times without incurring any reads/writes to the database, and, when the transition ID is in the cache, receive a ping from the first client to collect a lock table from the database to identify the second client, and receive the second client's lock information by receiving pings that do not carry lock information.
• According to yet another aspect, an example client computer for retrieval of metadata relating to a multi-client editing session includes a memory unit, and a processing unit operative to receive a document from a storage device, the document comprising short-term check out metadata indicating an editing session has begun, ping a cache to determine if another transition ID is stored in the cache, and send a transition ID to a transition table stored in a cache when the another transition ID is not stored in the cache to switch from a single-client mode to a multi-client mode when the another transition ID is stored in the cache.
• This Summary is provided to introduce a selection of concepts in a simplified form that are further described below in the Detailed Description. This Summary is not intended to identify key features or essential features of the claimed subject matter. Nor is this Summary intended to be used to limit the claimed subject matter's scope.
DESCRIPTION OF THE DRAWINGS
• Non-limiting and non-exhaustive embodiments are described with reference to the following figures, wherein like reference numerals refer to like parts throughout the various views unless otherwise specified.
• FIG. 1 is a schematic block diagram illustrating an example authoring system;
• FIG. 2 is a schematic block diagram illustrating the authoring system ofFIG. 1 in which a document stored on first computing device can include content and metadata;
• FIG. 3 is a schematic block diagram of an example lock table;
• FIG. 4 is a schematic block diagram of an example authoring environment including a first computing device on which a master copy of a document to be authored is to be stored;
• FIG. 5 is a schematic block diagram of an example client computing system configured to implement an authoring environment;
• FIG. 6 is a flowchart illustrating an example caching process implemented by an authoring application to recognizes a single or multiple clients editing a document; and
• FIG. 7 is a flowchart of an example subroutine used in the method ofFIG. 6 for writing a transition ID to a transition table.
DETAILED DESCRIPTION
• In the following detailed description, references are made to the accompanying drawings that form a part hereof, and in which are shown by way of illustrations specific embodiments or examples. While the disclosure will be described in the general context of program modules that execute in conjunction with an application program that runs on an operating system on a computer system, those skilled in the art will recognize that the disclosure also may be implemented in combination with other program modules. The embodiments described herein may be combined and other embodiments may be utilized without departing from the spirit or scope of the present disclosure. The following detailed description is therefore not to be taken in a limiting sense, and the scope of the disclosure is defined by the appended claims and their equivalents.
• Embodiments of the present disclosure provide an environment in which multiple clients can collaboratively author a document while consuming minimal server resources. In example embodiments, when a coauthoring capable application is editing a document, the application adds coauthoring metadata to the document and keeps a server copy of the file updated with the latest metadata. The coauthoring metadata and server copy allows seamlessly transitions from a single client to a multi-client editing state and vice versa. To keep conflicts to a minimum, the coauthoring metadata is uploaded to the server. When a new client opens the document, the client is notified of the areas of the document where other clients are working.
• FIG. 1 illustrates anexample authoring system100 having features that illustrate examples aspects of the disclosure. Theauthoring system100 includes astorage device120 storing a master copy of adocument150. In one embodiment, thestorage device120 may include, but not limited to, a server, a client computer, or other computing device. In another embodiment, thestorage device120 can include one or more storage devices (e.g., a network of computing devices).
• Theauthoring system100 also includes at least one client computing device110 that is communicatively coupled to thestorage device120. Each of the client computing devices110 can edit thedocument150 by creating a client copy155 of thedocument150 and editing the client copy155. The client copies155 of thedocument150 are synchronized when the client computing devices110 periodically send to thestorage device120 updates to be shared with the other client computing devices and periodically obtain from thestorage device120 updates from other client computing devices.
• As the term is used herein, a client computing device110 includes any computing device that obtains a client copy of a document to be authored from a master copy of the document. The client computing device110 can be different from thestorage device120 or can include a different client account implemented on thestorage device120. In one embodiment, a computing device that acts as astorage device120 for one document may act as a client computing device110 for a different document and vice versa.
• In the example shown, fourclient computing devices110A,110B,110C, and110D are communicatively coupled to thestorage device120. In other embodiments, however, any number of computing devices110 may be coupled to thestorage device120. In the example shown, eachclient computing device110A,110B,110C,110D can send to thestorage device120 updates generated by the client of the client computing device and can request from thestorage device120 updates generated by the clients of the other client computing devices. In one embodiment, thestorage device120 can be a server computing device and theclient computing devices110A,110B,110C,110D can be client computing devices. Other system configurations are possible. For example, in an alternative embodiment, multiple server computing devices can be used.
• As shown inFIG. 2, thedocument150 stored on thestorage device120 can includecontent152 andmetadata154. Authoringapplications130 on the client computing devices110 process and manipulate the content and metadata of the client copies155 of thedocument150. In some embodiments,metadata154 can be stored separately fromcontent152. For example,content152 can be stored in thedocument150 andmetadata154 can be stored in a table (seeFIG. 3) separate from thedocument150. In other embodiments, however, themetadata154 can be stored within thedocument150.
• In general, the client computing devices110 can synchronize updates to thecontent152 separately from updates to themetadata154. In general,metadata updates154 are automatically synchronized among thestorage device120 and client computing devices110, whereascontent updates152 from each client computing device110 are synchronized at the request of the respective client.
• Referring toFIG. 3, lock metadata can be stored in a variety of different formats. For example, the lock metadata ofFIG. 3 is stored in a table format300. The lock table300 ofFIG. 3 includes a list of clients, each of whom is identified with a client identifier (e.g., an identification number) that is uniquely assigned to the client. Data units to be locked are identified with unit identifiers (e.g., identification numbers) that are uniquely assigned to each data unit within a document. The lock table300 associates the unit identifiers of the one or more data units to be locked with the client identifiers of the clients who own the locks.
• For example, in the lock table300, data units312 and314 are associated with a first client310. Other clients, therefore, are inhibited from editing data units312 and314. Data unit322 is associated with client320. Other clients, including the first client310, therefore, are inhibited from editing data unit322. The fourth client340 has not locked any portion of the document and so is not associated with any unit identifiers. In other embodiments, however, lock metadata can be stored in a different format or within the document. For example, the lock table300 can be arranged by unit identifier instead of by client identifier.
• Presence metadata also can be stored in a variety of formats. For example, presence metadata can be stored in the lock table300 ofFIG. 3. In another embodiment, however, presence metadata can be stored in a separate table or in a different format. Presence metadata includes the client identifier of each client that is currently accessing the document or that has staked a claim (e.g., generated a content lock) on a data unit of the document. For example, a metadata table, such as the lock table300, can store the client identifier of each client having a claim to at least one data unit of the document. Like lock metadata, presence metadata can be synchronized automatically.
• FIGS. 4 and 5 provide greater detail in how coauthoring between the client copy and the master copy of the document is implemented by a client computing device.FIG. 4 is a schematic block diagram of anauthoring system400 including astorage device420 on which a master copy of a document to be authored is to be stored. Theauthoring system400 also includes at least oneclient computing device410 communicatively coupled to thestorage device420.
• Theclient computing device410 includes anauthoring application412 configured to provide an authoring environment in which a client can create and/or manipulate a document to be authored. Theclient computing device410 also includes acache414, a layer object (“LO”)416, and a synchronization manager (“sync manager”)418. Thecache414 stores a client copy of the document to be authored. Thecache414 also stores the metadata, including lock and presence metadata, associated with the document. Updates to the content and metadata of the document also can be stored in thecache414.
• Thelayer object416 provides an interface between theauthoring application412 and thecache414. Thelayer object416 also provides an interface between theauthoring application412 and thesync manager418. Thesync manager418 communicates with thestorage device420 and provides an interface between thestorage device420 and thecache414. For example, thesync manager418 can send updates to and obtain updates from thestorage device420 and thecache414.
• In general, an authoring environment having features that are examples of aspects in accordance with the principles of the disclosure can be implemented on a client computing device (e.g., a personal computer, a server computer, a notebook computer, a PDA, a Smartphone, or any other such computing device). A non-limiting embodiment of aclient computing system500 configured to implement an authoring environment is described herein with reference toFIG. 5.
• InFIG. 5, theexemplary computing system500 for implementing the principles of the disclosure includes a client computing device, such asclient computing device510. In a basic configuration, theclient computing device510 typically includes at least oneprocessing unit515 for executing applications and programs stored insystem memory520. Depending on the exact configuration and type ofcomputing device510, thesystem memory520 may include, but is not limited to, RAM, ROM, EEPROM, flash memory, CD-ROM, digital versatile disks (DVD) or other optical storage devices, magnetic cassettes, magnetic tape, magnetic disk storage or other magnetic storage devices, or other memory technology.
• System memory520 typically stores anoperating system522, such as the WINDOWS® operating systems from Microsoft Corporation of Redmond, Wash., suitable for controlling the operation of thecomputing device510.System memory520 also may include adocument cache526 in which aclient copy527 of a document can be stored.Metadata529 of the document also can be stored within theclient cache526.
• Thesystem memory520 also may store one or more software applications, such asauthoring applications524 for creating and editing documents. One non-limiting example of anauthoring application524 suitable for authoring documents in accordance with the principles of the present disclosure is Word word processing software from Microsoft Corporation. Other non-limiting examples of authoring applications include POWERPOINT® presentation software and VISIO® drawing and diagramming software, both also from Microsoft Corporation. Other software applications can also be used.
• Computing device510 also may have input device(s)530, such as a keyboard, mouse, pen, voice input device, touch input device, etc., for entering and manipulating data. Output device(s)535, such as a display screen, speakers, printer, etc., also may be included. Theseoutput devices535 are well known in the art and need not be discussed at length herein.
• Thecomputing device510 also may containcommunication connections540 that allow thedevice510 to communicate with other computing devices, for example, thestorage device420 ofFIG. 4, over a network in a distributed computing environment (e.g., an intranet or the Internet). By way of example, and not limitation,communication device media540 includes wired media such as a wired network or direct-wired connection, and wireless media, such as acoustic, RF, infrared and other wireless media.
• Turning now toFIG. 6 is a flow chart setting forth the general stages involved in amethod600 consistent with an embodiment of the disclosure for retrieving presence metadata.Method600 may be implemented using acomputing device510 as described in above with respect toFIG. 5. Ways to implement the stages ofmethod600 will be described in greater detail below.Method600 may begin at startingblock605 and proceed to stage610 wherecomputing device510 may receivemetadata529. For example, a client using computing device510 (e.g. a client computer) may open a document (e.g.150). Opening the document may causecomputing device510 to receive short-term check out metadata for the document.
• Fromstage610, wherecomputing device510 receivedmetadata529,method600 may advance to stage620 wherecomputing device510 may add a transition ID to themetadata529.
• Oncecomputing device510 adds the transition ID tometadata529 instage620,method600 may continue to subroutine630 wherecomputing device510 may write the transition ID to a transition table stored incache526. For example, writing the transition ID to metadata529 may indicate more than one client is editing the document (i.e. switching from a single-client mode to a multi-client mode) as show inFIG. 7.
• In one example, the transition ID is a unique number, such as a Globally Unique Identifier (GUID—i.e., a pseudo-random 128-bit number). The transition table is a list of the transition IDs. The transition table can also include an expiration date for each transition ID. The expiration date can be used to clear a transition ID when a client forces creation of a transition ID and thereupon abandon editing of the document without notification. Other configurations are possible.
• Fromsubroutine stage630, wherecomputing device510 may write the transition ID to a transition table stored incache526,method600 may advance to stage640 wherecomputing device510 may ping storage device120 (e.g. a server) to determine if the transition ID is incache526.
• When the transition ID is not in the cache,computing device510 may ping the server at regular intervals, and save the document to the server a plurality of times without incurring any reads/writes to a database that stores presence information.
• When the transition ID is in the cache,computing device510 may ping the server to collect a lock table from a database to identify a new client, and in a separate web service request, submitting the client's lock information.Computing device510 may then delete the transition ID from the transition table.
• Computing device510 may also submit a client's lock information. Submitting the client's lock information may include pinging the server. For example, the computing device can submit “am I alone” pings to the server, wherein the “am I alone” pings do not carry lock information. An “am I alone” ping is simply a ping to the server or other storage device whereincomputing device510 is requesting information to determine if the document is being edit by another client or if another client had begun editing the document after the client began editing the document.
• Every time each client downloads presence metadata, the number of clients in an editing session and the last time each client updated their presence information (e.g., transition ID, transition table, database, etc.) may be checked (among other things), at regular intervals. If the presence information has not been updated by any client in a configurable window of time, it is considered a violent exit from the session. Any client who first observes this exit can delete the client from the presence information. Further, the delete operation should be a graceful merge so that any other client who also made the same observation can re-request the omissions which results in a no-op in the server.
• If the presence information reflects only one client (which should be the examining client, i.e., computing device510), the following actions may be done to minimize problems associated with the timing of the change of state of the document: 1) clear-up the presence table so it reflects the state as a single client mode; 2) delete the transition ID to the transition table; and 3) start the “am I alone” pings at regular intervals.
• The transition ID in the transition table indicates another user has joined the coauthoring session and is in transition back to multi-user authoring. When the system transitions back to one client editing, that client starts sending the “am I alone” pings. The “am I alone” pings returned to the client indicate the client is alone until another client puts the transition ID back in the transition table.
• Oncecomputing device510pings storage device120 instage640,method600 may continue to stage650 wherecomputing device510 may refreshcache526.
• For example,computing device510 may refreshcache526 by updating the transition table stored incache526. For instance updating the transition table may include pingingcache526 to check for the presence of the transition ID incache526. When the transition ID is not present incache526, a determination may be made to see ifcache526 has been refreshed within a predetermined time interval. Whencache526 has been refreshed within the predetermined time interval, a response to the ping may be sent fromcache526. Whencache526 has not been refreshed within the predetermined time interval, the transition table corresponding to the document's content database may be fetched. Oncecomputing device510 hasrefresh cache526 instage650,method600 may then end atstage660.
• FIG. 7 is a flow chart showing example stages ofsubroutine630.Subroutine630 begins at startingblock705 and proceeds to stage710 wherecomputing device510 may determine if the document is already being used in the multi-client mode. For example,computing device510 may determine if the document is in multi-client mode by checking a database. Ifcomputing device510 determines the document is not in multi-client mode instage710,subroutine630 may proceed to stage715 wherecomputing device510 switch from a single-client mode to a multi-client mode.
• For example, switching from single-client mode to multi-client mode may be initiated by a second client attempting to take another short-term lock on the document and seeing that that the client has already received the document. Switching to multi-client mode may includecomputing device510 receiving the document and transition ID atcache526. In thisinstance computing device510 may actually be a second client computing device. After receiving the transition ID,computing device510 may write the transition ID to the transition table, and write to the database information indicating the second client has joined the editing session and is now working on the document.
• Ifcomputing device510 determines the document is in multi-client mode instage710,subroutine630 may continue to stage720 wherecomputing device510 may adds the client as the “nth” client. For example, adding the “nth” client may includecomputing device510 receiving the document and transition ID, and writing to the database information indicating the “nth” client has joined the editing session.
• Fromstage715 wherecomputing device510 switches from single-client mode to multi-client mode orstage720 wherecomputing device510 adds the “nth” client,subroutine630 may advance to stage730 wherecomputing device510 may return to stage640 (FIG. 6).
• Reference may be made throughout this specification to “one embodiment,” “an embodiment,” “embodiments,” “an aspect,” or “aspects” meaning that a particular described feature, structure, or characteristic may be included in at least one embodiment of the present disclosure. Thus, usage of such phrases may refer to more than just one embodiment or aspect. In addition, the described features, structures, or characteristics may be combined in any suitable manner in one or more embodiments or aspects. Furthermore, reference to a single item may mean a single item or a plurality of items, just as reference to a plurality of items may mean a single item. Moreover, use of the term “and” when incorporated into a list is intended to imply that all the elements of the list, a single item of the list, or any combination of items in the list has been contemplated.
• Embodiments of the disclosure may be implemented as a computer process (method), a computing system, or as an article of manufacture, such as a computer program product or computer readable media. The processes (programs) can be implemented in any number of ways, including the structures described in this document. One such way is by machine operations, of devices of the type described in this document. Another optional way is for one or more of the individual operations of the methods to be performed on a computing device in conjunction with one or more human operators performing some of the operations. These human operators need not be collocated with each other, but each can be only with a machine that performs a portion of the program.
• The computer program product may be a computer storage media readable by a computer system and encoding a computer program of instructions for executing a computer process. The computer program product may also be a propagated signal on a carrier readable by a computing system and encoding a computer program of instructions for executing a computer process. The term computer readable media as used herein includes both storage media and communication media.
• Those skilled in the art will appreciate that the disclosure may be practiced with other computer system configurations, including hand-held devices, multiprocessor systems, microprocessor-based or programmable consumer electronics, minicomputers, mainframe computers, and the like. The disclosure may also be practiced in distributed computing environments where tasks are performed by remote processing devices that are linked through a communications network. In a distributed computing environment, program modules may be located in both local and remote memory storage devices. Generally, program modules include routines, programs, components, data structures, and other types of structures that perform particular tasks or implement particular abstract data types.

Claims (21)

1-20. (canceled)

21. A method for updating presence information for a document, the method comprising:

receiving, at a first client, short term check out metadata by opening the document, the short term check out metadata comprising presence metadata;

adding a transition ID for the first client to the short term check out metadata;

sending the transition ID to a transition table stored in a cache;

determining that presence information in the cache has not been updated by a second client in a configurable window of time; and

upon determining that the presence information has not been updated, deleting the presence information of the second client.

22. The method ofclaim 21, wherein adding the transition ID for the first client switches the document to a multi client editing mode.

23. The method ofclaim 21, wherein deleting the presence information of the second client indicates that the document is in a single client editing mode.

24. The method ofclaim 21, further comprising:

deleting the transition ID from the transition table.

25. The method ofclaim 21, further comprising:

pinging the server to determine whether a new transition ID has been added to the transition table.

26. The method ofclaim 25, further comprising

receiving a ping from the server indicating that the document is still in the single client editing mode.

27. The method ofclaim 25, further comprising

receiving a ping from the server indicating that the document has switched to the multi client editing mode.

28. One or more computer storage media not consisting of a propagated data signal and having computer-executable instructions that, when executed, provide a method for updating presence information for a document, the method comprising:

receiving, at a first client, short term check out metadata by opening the document, the short term check out metadata comprising presence metadata;

adding a transition ID for the first client to the short term check out metadata;

sending the transition ID to a transition table stored in a cache;

determining that presence information in the cache has not been updated by a second client in a configurable window of time; and

upon determining that the presence information has not been updated, deleting the presence information of the second client.

29. The one or more computer storage media ofclaim 28, wherein adding the transition ID for the first client switches the document to a multi client editing mode.

30. The one or more computer storage media ofclaim 28, wherein deleting the presence information of the second client indicates that the document is in a single client editing mode.

31. The one or more computer storage media ofclaim 28, further comprising:

deleting the transition ID from the transition table.

32. The one or more computer storage media ofclaim 28, further comprising:

pinging the server to determine whether a new transition ID has been added to the transition table.

33. The one or more computer storage media ofclaim 32, further comprising

receiving a ping from the server indicating that the document is still in the single client editing mode.

34. The one or more computer storage media ofclaim 32, further comprising

receiving a ping from the server indicating that the document has switched to the multi client editing mode.

35. A computer system comprising:

a processor; and

a memory communicatively coupled to the processor, the memory having computer-executable instructions that when executed by the processor, provide a method for updating presence information for a document, the method comprising:

receiving, at a first client, short term check out metadata by opening the document, the short term check out metadata comprising presence metadata;

adding a transition ID for the first client to the short term check out metadata;

sending the transition ID to a transition table stored in a cache;

determining that presence information in the cache has not been updated by a second client in a configurable window of time; and

upon determining that the presence information has not been updated, deleting the presence information of the second client.

36. The computer system ofclaim 35, wherein adding the transition ID for the first client switches the document to a multi client editing mode.

37. The computer system ofclaim 35, wherein deleting the presence information of the second client indicates that the document is in a single client editing mode.

38. The computer system ofclaim 35, further comprising:

deleting the transition ID from the transition table.

39. The computer system ofclaim 35, further comprising:

pinging the server to determine whether a new transition ID has been added to the transition table.

40. The computer system ofclaim 39, further comprising

receiving a ping from the server indicating that the document has switched to the multi client editing mode.

Images